Microsoft.Billing (stable:2024-04-01)

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

Agreements_Get (new)
Description :  Gets an agreement by ID.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: An agreement. ,
Required: False ,
}
{
acceptanceMode:
{
Description: The mode of acceptance for an agreement. ,
Enum:
{
Other: No description available. ,
ClickToAccept: No description available. ,
ESignEmbedded: No description available. ,
ESignOffline: No description available. ,
Implicit: No description available. ,
Offline: No description available. ,
PhysicalSign: No description available. ,
}
,
Required: False ,
}
enum ,
agreementLink:
{
Description: The URL to download the agreement. ,
Required: False ,
}
string ,
billingProfileInfo:
{
Description: The list of billing profiles associated with agreement and present only for specific agreements. ,
Required: False ,
}
[
{
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The friendly ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileSystemId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
indirectRelationshipOrganizationName:
{
Description: Billing account name. Available for a specific type of agreement. ,
Required: False ,
}
string ,
}
,
]
,
category:
{
Description: The category of the agreement. ,
Enum:
{
Other: No description available. ,
AffiliatePurchaseTerms: No description available. ,
IndirectForGovernmentAgreement: No description available. ,
MicrosoftCustomerAgreement: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
UKCloudComputeFramework: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The name of the agreement signed by a customer. ,
Required: False ,
}
string ,
effectiveDate:
{
Description: The date from which the agreement is effective. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date when the agreement expires. ,
Format: date-time ,
Required: False ,
}
string ,
participants:
{
Description: The list of participants that participates in acceptance of an agreement. ,
Required: False ,
}
[
{
email:
{
Description: The email address of the participant. ,
Required: False ,
}
string ,
status:
{
Description: The acceptance status of the participant. ,
Required: False ,
}
string ,
statusDate:
{
Description: The date when the status got changed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The current status of the agreement. ,
Required: False ,
}
string ,
leadBillingAccountName:
{
Description: The ID of the lead billing account if this agreement is part of the Customer Affiliate Purchase Terms. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Agreements_ListByBillingAccount (new)
Description :  Lists the agreements for a billing account.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: An agreement. ,
Required: False ,
}
{
acceptanceMode:
{
Description: The mode of acceptance for an agreement. ,
Enum:
{
Other: No description available. ,
ClickToAccept: No description available. ,
ESignEmbedded: No description available. ,
ESignOffline: No description available. ,
Implicit: No description available. ,
Offline: No description available. ,
PhysicalSign: No description available. ,
}
,
Required: False ,
}
enum ,
agreementLink:
{
Description: The URL to download the agreement. ,
Required: False ,
}
string ,
billingProfileInfo:
{
Description: The list of billing profiles associated with agreement and present only for specific agreements. ,
Required: False ,
}
[
{
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The friendly ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileSystemId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
indirectRelationshipOrganizationName:
{
Description: Billing account name. Available for a specific type of agreement. ,
Required: False ,
}
string ,
}
,
]
,
category:
{
Description: The category of the agreement. ,
Enum:
{
Other: No description available. ,
AffiliatePurchaseTerms: No description available. ,
IndirectForGovernmentAgreement: No description available. ,
MicrosoftCustomerAgreement: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
UKCloudComputeFramework: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The name of the agreement signed by a customer. ,
Required: False ,
}
string ,
effectiveDate:
{
Description: The date from which the agreement is effective. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date when the agreement expires. ,
Format: date-time ,
Required: False ,
}
string ,
participants:
{
Description: The list of participants that participates in acceptance of an agreement. ,
Required: False ,
}
[
{
email:
{
Description: The email address of the participant. ,
Required: False ,
}
string ,
status:
{
Description: The acceptance status of the participant. ,
Required: False ,
}
string ,
statusDate:
{
Description: The date when the status got changed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The current status of the agreement. ,
Required: False ,
}
string ,
leadBillingAccountName:
{
Description: The ID of the lead billing account if this agreement is part of the Customer Affiliate Purchase Terms. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssociatedTenants_Delete (new)
Description :  Deletes an associated tenant for a billing account.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/associatedTenants/{associatedTenantName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
associatedTenantName:
{
Description: The ID that uniquely identifies a tenant. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssociatedTenants_Get (new)
Description :  Gets an associated tenant by ID.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: An associated tenant. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The name of the associated tenant. ,
Required: False ,
}
string ,
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
billingManagementState:
{
Description: The state determines whether users from the associated tenant can be assigned roles for commerce activities like viewing and downloading invoices, managing payments, and making purchases. ,
Enum:
{
Other: No description available. ,
NotAllowed: No description available. ,
Active: No description available. ,
Revoked: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningManagementState:
{
Description: The state determines whether subscriptions and licenses can be provisioned in the associated tenant. It can be set to 'Pending' to initiate a billing request. ,
Enum:
{
Other: No description available. ,
NotRequested: No description available. ,
Active: No description available. ,
Pending: No description available. ,
BillingRequestExpired: No description available. ,
BillingRequestDeclined: No description available. ,
Revoked: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningBillingRequestId:
{
Description: The unique identifier for the billing request that is created when enabling provisioning for an associated tenant. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssociatedTenants_CreateOrUpdate (new)
Description :  Create or update an associated tenant for the billing account.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/associatedTenants/{associatedTenantName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
associatedTenantName:
{
Description: The ID that uniquely identifies a tenant. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: An associated tenant. ,
Required: True ,
}
{
properties:
{
Description: An associated tenant. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The name of the associated tenant. ,
Required: False ,
}
string ,
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
billingManagementState:
{
Description: The state determines whether users from the associated tenant can be assigned roles for commerce activities like viewing and downloading invoices, managing payments, and making purchases. ,
Enum:
{
Other: No description available. ,
NotAllowed: No description available. ,
Active: No description available. ,
Revoked: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningManagementState:
{
Description: The state determines whether subscriptions and licenses can be provisioned in the associated tenant. It can be set to 'Pending' to initiate a billing request. ,
Enum:
{
Other: No description available. ,
NotRequested: No description available. ,
Active: No description available. ,
Pending: No description available. ,
BillingRequestExpired: No description available. ,
BillingRequestDeclined: No description available. ,
Revoked: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningBillingRequestId:
{
Description: The unique identifier for the billing request that is created when enabling provisioning for an associated tenant. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: An associated tenant. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The name of the associated tenant. ,
Required: False ,
}
string ,
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
billingManagementState:
{
Description: The state determines whether users from the associated tenant can be assigned roles for commerce activities like viewing and downloading invoices, managing payments, and making purchases. ,
Enum:
{
Other: No description available. ,
NotAllowed: No description available. ,
Active: No description available. ,
Revoked: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningManagementState:
{
Description: The state determines whether subscriptions and licenses can be provisioned in the associated tenant. It can be set to 'Pending' to initiate a billing request. ,
Enum:
{
Other: No description available. ,
NotRequested: No description available. ,
Active: No description available. ,
Pending: No description available. ,
BillingRequestExpired: No description available. ,
BillingRequestDeclined: No description available. ,
Revoked: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningBillingRequestId:
{
Description: The unique identifier for the billing request that is created when enabling provisioning for an associated tenant. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location: string ,
retry-after: integer ,
}
,
$schema:
{
Description: An associated tenant. ,
}
{
properties:
{
Description: An associated tenant. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The name of the associated tenant. ,
Required: False ,
}
string ,
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
billingManagementState:
{
Description: The state determines whether users from the associated tenant can be assigned roles for commerce activities like viewing and downloading invoices, managing payments, and making purchases. ,
Enum:
{
Other: No description available. ,
NotAllowed: No description available. ,
Active: No description available. ,
Revoked: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningManagementState:
{
Description: The state determines whether subscriptions and licenses can be provisioned in the associated tenant. It can be set to 'Pending' to initiate a billing request. ,
Enum:
{
Other: No description available. ,
NotRequested: No description available. ,
Active: No description available. ,
Pending: No description available. ,
BillingRequestExpired: No description available. ,
BillingRequestDeclined: No description available. ,
Revoked: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningBillingRequestId:
{
Description: The unique identifier for the billing request that is created when enabling provisioning for an associated tenant. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssociatedTenants_ListByBillingAccount (new)
Description :  Lists the associated tenants that can collaborate with the billing account on commerce activities like viewing and downloading invoices, managing payments, making purchases, and managing or provisioning licenses.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/associatedTenants
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
includeRevoked:
{
Description: Can be used to get revoked associated tenants. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: An associated tenant. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The name of the associated tenant. ,
Required: False ,
}
string ,
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
billingManagementState:
{
Description: The state determines whether users from the associated tenant can be assigned roles for commerce activities like viewing and downloading invoices, managing payments, and making purchases. ,
Enum:
{
Other: No description available. ,
NotAllowed: No description available. ,
Active: No description available. ,
Revoked: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningManagementState:
{
Description: The state determines whether subscriptions and licenses can be provisioned in the associated tenant. It can be set to 'Pending' to initiate a billing request. ,
Enum:
{
Other: No description available. ,
NotRequested: No description available. ,
Active: No description available. ,
Pending: No description available. ,
BillingRequestExpired: No description available. ,
BillingRequestDeclined: No description available. ,
Revoked: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningBillingRequestId:
{
Description: The unique identifier for the billing request that is created when enabling provisioning for an associated tenant. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AvailableBalances_GetByBillingAccount (new)
Description :  The Available Credit or Payment on Account Balance for a billing account. The credit balance can be used to settle due or past due invoices and is supported for billing accounts with agreement type Microsoft Customer Agreement. The payment on account balance is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Online Services Program.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The Available Credit or Payment on Account Balance. The credit balance can be used to settle due or past due invoices. ,
Required: False ,
}
{
amount:
{
Description: Credit amount for immediate payment. ,
Required: False ,
}
string ,
paymentsOnAccount:
{
Description: The list of payments on accounts. ,
Required: False ,
}
[
{
amount:
{
Description: Payment on Account amount. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile for the payments on account. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for the payments on account. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The ID of the invoice for which the payments on account was generated. ,
Required: False ,
}
string ,
invoiceName:
{
Description: The name of the invoice for the payments on account. ,
Required: False ,
}
string ,
date:
{
Description: The date of the payments on account. ,
Format: date-time ,
Required: False ,
}
string ,
paymentMethodType:
{
Description: Payment on Account type. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
totalPaymentsOnAccount:
{
Description: Total amount of payments on accounts. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AvailableBalances_GetByBillingProfile (new)
Description :  The Available Credit or Payment on Account Balance for a billing profile. The credit balance can be used to settle due or past due invoices and is supported for billing accounts with agreement type Microsoft Customer Agreement. The payment on account balance is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The Available Credit or Payment on Account Balance. The credit balance can be used to settle due or past due invoices. ,
Required: False ,
}
{
amount:
{
Description: Credit amount for immediate payment. ,
Required: False ,
}
string ,
paymentsOnAccount:
{
Description: The list of payments on accounts. ,
Required: False ,
}
[
{
amount:
{
Description: Payment on Account amount. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile for the payments on account. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for the payments on account. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The ID of the invoice for which the payments on account was generated. ,
Required: False ,
}
string ,
invoiceName:
{
Description: The name of the invoice for the payments on account. ,
Required: False ,
}
string ,
date:
{
Description: The date of the payments on account. ,
Format: date-time ,
Required: False ,
}
string ,
paymentMethodType:
{
Description: Payment on Account type. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
totalPaymentsOnAccount:
{
Description: Total amount of payments on accounts. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingAccounts_AddPaymentTerms (new)
Description :  Adds payment terms to all the billing profiles under the billing account. Currently, payment terms can be added only on billing accounts that have Agreement Type as 'Microsoft Customer Agreement' and AccountType as 'Enterprise'. This action needs pre-authorization and only Field Sellers are authorized to add the payment terms and is not a self-serve action.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/addPaymentTerms
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of payment term. ,
Required: True ,
}
{
term:
{
Description: Represents duration in netXX format. Always in days. ,
Required: False ,
}
string ,
startDate:
{
Description: The date on when the defined 'Payment Term' will be effective from and is always in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date on when the defined 'Payment Term' will end and is always in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
isDefault:
{
Description: Indicates payment term is the standard payment term. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A billing account. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatus:
{
Description: The current status of the billing account. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
UnderReview: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Extended: No description available. ,
Pending: No description available. ,
New: No description available. ,
Expired: No description available. ,
Terminated: No description available. ,
Transferred: No description available. ,
}
,
Required: False ,
}
enum ,
accountType:
{
Description: The type of customer. ,
Enum:
{
Other: No description available. ,
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
Reseller: No description available. ,
ClassicPartner: No description available. ,
Internal: No description available. ,
Tenant: No description available. ,
Business: No description available. ,
}
,
Required: False ,
}
enum ,
accountSubType:
{
Description: The tier of the account. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Individual: No description available. ,
Professional: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatusReasonCode:
{
Description: Reason for the specified billing account status. ,
Enum:
{
Other: No description available. ,
UnusualActivity: No description available. ,
ManuallyTerminated: No description available. ,
Expired: No description available. ,
Transferred: No description available. ,
TerminateProcessing: No description available. ,
}
,
Required: False ,
}
enum ,
agreementType:
{
Description: The type of agreement. ,
Enum:
{
Other: No description available. ,
MicrosoftCustomerAgreement: No description available. ,
EnterpriseAgreement: No description available. ,
MicrosoftOnlineServicesProgram: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
enrollmentDetails:
{
Description: The properties of an enrollment. ,
Required: False ,
}
string ,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing account. ,
Required: False ,
}
boolean ,
hasNoBillingProfiles:
{
Description: Indicates whether or not the billing account has any billing profiles. ,
Required: False ,
}
boolean ,
notificationEmailAddress:
{
Description: Notification email address for legacy account. Available for agreement type Microsoft Online Services Program. ,
Required: False ,
}
string ,
primaryBillingTenantId:
{
Description: The tenant that was used to set up the billing account. By default, only users from this tenant can get role assignments on the billing account and all purchases are provisioned in this tenant. ,
Required: False ,
}
string ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
string ,
registrationNumber:
{
Description: Describes the registration number of the organization linked with the billing account. ,
Required: False ,
}
string ,
billingRelationshipTypes:
{
Description: Identifies the billing relationships represented by a billing account. The billing relationship may be between Microsoft, the customer, and/or a third-party. ,
Required: False ,
}
[
string ,
]
,
qualifications:
{
Description: Qualifications for pricing on a billing account. Values may be Commercial, Education, Charity or Government. ,
Required: False ,
}
[
string ,
]
,
taxIds:
{
Description: A list of tax identifiers for the billing account. ,
Required: False ,
}
[
{
id:
{
Description: The id of the tax identifier. ,
Required: False ,
}
string ,
type:
{
Description: The type of the tax identifier. ,
Enum:
{
Other: No description available. ,
BrazilCcmId: No description available. ,
BrazilCnpjId: No description available. ,
BrazilCpfId: No description available. ,
CanadianFederalExempt: No description available. ,
CanadianProvinceExempt: No description available. ,
ExternalTaxation: No description available. ,
IndiaFederalTanId: No description available. ,
IndiaFederalServiceTaxId: No description available. ,
IndiaPanId: No description available. ,
IndiaStateCstId: No description available. ,
IndiaStateGstINId: No description available. ,
IndiaStateVatId: No description available. ,
IntlExempt: No description available. ,
USExempt: No description available. ,
VatId: No description available. ,
LoveCode: No description available. ,
MobileBarCode: No description available. ,
NationalIdentificationNumber: No description available. ,
PublicSectorId: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope of the tax identifier. ,
Required: False ,
}
string ,
country:
{
Description: The country of the tax identifier. ,
Required: False ,
}
string ,
status:
{
Description: The status of the tax identifier. ,
Enum:
{
Other: No description available. ,
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingAccounts_CancelPaymentTerms (new)
Description :  Cancels all the payment terms on billing account that falls after the cancellation date in the request. Currently, cancel payment terms is only served by admin actions and is not a self-serve action.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/cancelPaymentTerms
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Date after which any payment terms that needs to be cancelled. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A billing account. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatus:
{
Description: The current status of the billing account. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
UnderReview: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Extended: No description available. ,
Pending: No description available. ,
New: No description available. ,
Expired: No description available. ,
Terminated: No description available. ,
Transferred: No description available. ,
}
,
Required: False ,
}
enum ,
accountType:
{
Description: The type of customer. ,
Enum:
{
Other: No description available. ,
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
Reseller: No description available. ,
ClassicPartner: No description available. ,
Internal: No description available. ,
Tenant: No description available. ,
Business: No description available. ,
}
,
Required: False ,
}
enum ,
accountSubType:
{
Description: The tier of the account. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Individual: No description available. ,
Professional: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatusReasonCode:
{
Description: Reason for the specified billing account status. ,
Enum:
{
Other: No description available. ,
UnusualActivity: No description available. ,
ManuallyTerminated: No description available. ,
Expired: No description available. ,
Transferred: No description available. ,
TerminateProcessing: No description available. ,
}
,
Required: False ,
}
enum ,
agreementType:
{
Description: The type of agreement. ,
Enum:
{
Other: No description available. ,
MicrosoftCustomerAgreement: No description available. ,
EnterpriseAgreement: No description available. ,
MicrosoftOnlineServicesProgram: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
enrollmentDetails:
{
Description: The properties of an enrollment. ,
Required: False ,
}
string ,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing account. ,
Required: False ,
}
boolean ,
hasNoBillingProfiles:
{
Description: Indicates whether or not the billing account has any billing profiles. ,
Required: False ,
}
boolean ,
notificationEmailAddress:
{
Description: Notification email address for legacy account. Available for agreement type Microsoft Online Services Program. ,
Required: False ,
}
string ,
primaryBillingTenantId:
{
Description: The tenant that was used to set up the billing account. By default, only users from this tenant can get role assignments on the billing account and all purchases are provisioned in this tenant. ,
Required: False ,
}
string ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
string ,
registrationNumber:
{
Description: Describes the registration number of the organization linked with the billing account. ,
Required: False ,
}
string ,
billingRelationshipTypes:
{
Description: Identifies the billing relationships represented by a billing account. The billing relationship may be between Microsoft, the customer, and/or a third-party. ,
Required: False ,
}
[
string ,
]
,
qualifications:
{
Description: Qualifications for pricing on a billing account. Values may be Commercial, Education, Charity or Government. ,
Required: False ,
}
[
string ,
]
,
taxIds:
{
Description: A list of tax identifiers for the billing account. ,
Required: False ,
}
[
{
id:
{
Description: The id of the tax identifier. ,
Required: False ,
}
string ,
type:
{
Description: The type of the tax identifier. ,
Enum:
{
Other: No description available. ,
BrazilCcmId: No description available. ,
BrazilCnpjId: No description available. ,
BrazilCpfId: No description available. ,
CanadianFederalExempt: No description available. ,
CanadianProvinceExempt: No description available. ,
ExternalTaxation: No description available. ,
IndiaFederalTanId: No description available. ,
IndiaFederalServiceTaxId: No description available. ,
IndiaPanId: No description available. ,
IndiaStateCstId: No description available. ,
IndiaStateGstINId: No description available. ,
IndiaStateVatId: No description available. ,
IntlExempt: No description available. ,
USExempt: No description available. ,
VatId: No description available. ,
LoveCode: No description available. ,
MobileBarCode: No description available. ,
NationalIdentificationNumber: No description available. ,
PublicSectorId: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope of the tax identifier. ,
Required: False ,
}
string ,
country:
{
Description: The country of the tax identifier. ,
Required: False ,
}
string ,
status:
{
Description: The status of the tax identifier. ,
Enum:
{
Other: No description available. ,
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingAccounts_ConfirmTransition (new)
Description :  Gets the transition details for a billing account that has transitioned from agreement type Microsoft Online Services Program to agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
transitionDate:
{
Description: The transition completion date. ,
Format: date-time ,
Required: False ,
}
string ,
anniversaryDay:
{
Description: The anniversary day of the pre-transitioned account of type Microsoft Online Services Program. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingAccounts_ListInvoiceSectionsByCreateSubscriptionPermission (new)
Description :  Lists the invoice sections for which the user has permission to create Azure subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/listInvoiceSectionsWithCreateSubscriptionPermission
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileSystemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
billingProfileStatus:
{
Description: The status of the billing profile. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfileStatusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfileSpendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
enabledAzurePlans:
{
Description: Enabled azure plans for the associated billing profile. ,
Required: False ,
}
[
{
productId:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
skuId:
{
Description: The ID that uniquely identifies a sku. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionSystemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingAccounts_ValidatePaymentTerms (new)
Description :  Validates payment terms on a billing account with agreement type 'Microsoft Customer Agreement' and account type 'Enterprise'.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/validatePaymentTerms
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of payment term. ,
Required: True ,
}
{
term:
{
Description: Represents duration in netXX format. Always in days. ,
Required: False ,
}
string ,
startDate:
{
Description: The date on when the defined 'Payment Term' will be effective from and is always in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date on when the defined 'Payment Term' will end and is always in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
isDefault:
{
Description: Indicates payment term is the standard payment term. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
eligibilityStatus:
{
Description: Indicates the eligibility status of the payment terms. ,
Enum:
{
Other: No description available. ,
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
eligibilityDetails:
{
Description: Details of the payment terms eligibility. ,
Required: False ,
}
[
{
code:
{
Description: Indicates the reason for the ineligibility of the payment terms. ,
Enum:
{
Other: No description available. ,
OverlappingPaymentTerms: No description available. ,
InvalidDateFormat: No description available. ,
InvalidDateRange: No description available. ,
InactiveBillingAccount: No description available. ,
InvalidBillingAccountType: No description available. ,
NullOrEmptyPaymentTerms: No description available. ,
BillingAccountNotFound: No description available. ,
IneligibleBillingAccountStatus: No description available. ,
InvalidTerms: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Indicates the message for the ineligibility of the payment terms. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingAccounts_Get (new)
Description :  Gets a billing account by its ID.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: A billing account. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatus:
{
Description: The current status of the billing account. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
UnderReview: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Extended: No description available. ,
Pending: No description available. ,
New: No description available. ,
Expired: No description available. ,
Terminated: No description available. ,
Transferred: No description available. ,
}
,
Required: False ,
}
enum ,
accountType:
{
Description: The type of customer. ,
Enum:
{
Other: No description available. ,
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
Reseller: No description available. ,
ClassicPartner: No description available. ,
Internal: No description available. ,
Tenant: No description available. ,
Business: No description available. ,
}
,
Required: False ,
}
enum ,
accountSubType:
{
Description: The tier of the account. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Individual: No description available. ,
Professional: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatusReasonCode:
{
Description: Reason for the specified billing account status. ,
Enum:
{
Other: No description available. ,
UnusualActivity: No description available. ,
ManuallyTerminated: No description available. ,
Expired: No description available. ,
Transferred: No description available. ,
TerminateProcessing: No description available. ,
}
,
Required: False ,
}
enum ,
agreementType:
{
Description: The type of agreement. ,
Enum:
{
Other: No description available. ,
MicrosoftCustomerAgreement: No description available. ,
EnterpriseAgreement: No description available. ,
MicrosoftOnlineServicesProgram: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
enrollmentDetails:
{
Description: The properties of an enrollment. ,
Required: False ,
}
string ,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing account. ,
Required: False ,
}
boolean ,
hasNoBillingProfiles:
{
Description: Indicates whether or not the billing account has any billing profiles. ,
Required: False ,
}
boolean ,
notificationEmailAddress:
{
Description: Notification email address for legacy account. Available for agreement type Microsoft Online Services Program. ,
Required: False ,
}
string ,
primaryBillingTenantId:
{
Description: The tenant that was used to set up the billing account. By default, only users from this tenant can get role assignments on the billing account and all purchases are provisioned in this tenant. ,
Required: False ,
}
string ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
string ,
registrationNumber:
{
Description: Describes the registration number of the organization linked with the billing account. ,
Required: False ,
}
string ,
billingRelationshipTypes:
{
Description: Identifies the billing relationships represented by a billing account. The billing relationship may be between Microsoft, the customer, and/or a third-party. ,
Required: False ,
}
[
string ,
]
,
qualifications:
{
Description: Qualifications for pricing on a billing account. Values may be Commercial, Education, Charity or Government. ,
Required: False ,
}
[
string ,
]
,
taxIds:
{
Description: A list of tax identifiers for the billing account. ,
Required: False ,
}
[
{
id:
{
Description: The id of the tax identifier. ,
Required: False ,
}
string ,
type:
{
Description: The type of the tax identifier. ,
Enum:
{
Other: No description available. ,
BrazilCcmId: No description available. ,
BrazilCnpjId: No description available. ,
BrazilCpfId: No description available. ,
CanadianFederalExempt: No description available. ,
CanadianProvinceExempt: No description available. ,
ExternalTaxation: No description available. ,
IndiaFederalTanId: No description available. ,
IndiaFederalServiceTaxId: No description available. ,
IndiaPanId: No description available. ,
IndiaStateCstId: No description available. ,
IndiaStateGstINId: No description available. ,
IndiaStateVatId: No description available. ,
IntlExempt: No description available. ,
USExempt: No description available. ,
VatId: No description available. ,
LoveCode: No description available. ,
MobileBarCode: No description available. ,
NationalIdentificationNumber: No description available. ,
PublicSectorId: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope of the tax identifier. ,
Required: False ,
}
string ,
country:
{
Description: The country of the tax identifier. ,
Required: False ,
}
string ,
status:
{
Description: The status of the tax identifier. ,
Enum:
{
Other: No description available. ,
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingAccounts_Update (new)
Description :  Updates the properties of a billing account. Currently, displayName and address can be updated for billing accounts with agreement type Microsoft Customer Agreement. Currently address and notification email address can be updated for billing accounts with agreement type Microsoft Online Services Agreement. Currently, purchase order number can be edited for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: A billing account. ,
Required: True ,
}
{
properties:
{
Description: A billing account. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatus:
{
Description: The current status of the billing account. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
UnderReview: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Extended: No description available. ,
Pending: No description available. ,
New: No description available. ,
Expired: No description available. ,
Terminated: No description available. ,
Transferred: No description available. ,
}
,
Required: False ,
}
enum ,
accountType:
{
Description: The type of customer. ,
Enum:
{
Other: No description available. ,
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
Reseller: No description available. ,
ClassicPartner: No description available. ,
Internal: No description available. ,
Tenant: No description available. ,
Business: No description available. ,
}
,
Required: False ,
}
enum ,
accountSubType:
{
Description: The tier of the account. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Individual: No description available. ,
Professional: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatusReasonCode:
{
Description: Reason for the specified billing account status. ,
Enum:
{
Other: No description available. ,
UnusualActivity: No description available. ,
ManuallyTerminated: No description available. ,
Expired: No description available. ,
Transferred: No description available. ,
TerminateProcessing: No description available. ,
}
,
Required: False ,
}
enum ,
agreementType:
{
Description: The type of agreement. ,
Enum:
{
Other: No description available. ,
MicrosoftCustomerAgreement: No description available. ,
EnterpriseAgreement: No description available. ,
MicrosoftOnlineServicesProgram: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
enrollmentDetails:
{
Description: The properties of an enrollment. ,
Required: False ,
}
string ,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing account. ,
Required: False ,
}
boolean ,
hasNoBillingProfiles:
{
Description: Indicates whether or not the billing account has any billing profiles. ,
Required: False ,
}
boolean ,
notificationEmailAddress:
{
Description: Notification email address for legacy account. Available for agreement type Microsoft Online Services Program. ,
Required: False ,
}
string ,
primaryBillingTenantId:
{
Description: The tenant that was used to set up the billing account. By default, only users from this tenant can get role assignments on the billing account and all purchases are provisioned in this tenant. ,
Required: False ,
}
string ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
string ,
registrationNumber:
{
Description: Describes the registration number of the organization linked with the billing account. ,
Required: False ,
}
string ,
billingRelationshipTypes:
{
Description: Identifies the billing relationships represented by a billing account. The billing relationship may be between Microsoft, the customer, and/or a third-party. ,
Required: False ,
}
[
string ,
]
,
qualifications:
{
Description: Qualifications for pricing on a billing account. Values may be Commercial, Education, Charity or Government. ,
Required: False ,
}
[
string ,
]
,
taxIds:
{
Description: A list of tax identifiers for the billing account. ,
Required: False ,
}
[
{
id:
{
Description: The id of the tax identifier. ,
Required: False ,
}
string ,
type:
{
Description: The type of the tax identifier. ,
Enum:
{
Other: No description available. ,
BrazilCcmId: No description available. ,
BrazilCnpjId: No description available. ,
BrazilCpfId: No description available. ,
CanadianFederalExempt: No description available. ,
CanadianProvinceExempt: No description available. ,
ExternalTaxation: No description available. ,
IndiaFederalTanId: No description available. ,
IndiaFederalServiceTaxId: No description available. ,
IndiaPanId: No description available. ,
IndiaStateCstId: No description available. ,
IndiaStateGstINId: No description available. ,
IndiaStateVatId: No description available. ,
IntlExempt: No description available. ,
USExempt: No description available. ,
VatId: No description available. ,
LoveCode: No description available. ,
MobileBarCode: No description available. ,
NationalIdentificationNumber: No description available. ,
PublicSectorId: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope of the tax identifier. ,
Required: False ,
}
string ,
country:
{
Description: The country of the tax identifier. ,
Required: False ,
}
string ,
status:
{
Description: The status of the tax identifier. ,
Enum:
{
Other: No description available. ,
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A billing account. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatus:
{
Description: The current status of the billing account. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
UnderReview: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Extended: No description available. ,
Pending: No description available. ,
New: No description available. ,
Expired: No description available. ,
Terminated: No description available. ,
Transferred: No description available. ,
}
,
Required: False ,
}
enum ,
accountType:
{
Description: The type of customer. ,
Enum:
{
Other: No description available. ,
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
Reseller: No description available. ,
ClassicPartner: No description available. ,
Internal: No description available. ,
Tenant: No description available. ,
Business: No description available. ,
}
,
Required: False ,
}
enum ,
accountSubType:
{
Description: The tier of the account. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Individual: No description available. ,
Professional: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatusReasonCode:
{
Description: Reason for the specified billing account status. ,
Enum:
{
Other: No description available. ,
UnusualActivity: No description available. ,
ManuallyTerminated: No description available. ,
Expired: No description available. ,
Transferred: No description available. ,
TerminateProcessing: No description available. ,
}
,
Required: False ,
}
enum ,
agreementType:
{
Description: The type of agreement. ,
Enum:
{
Other: No description available. ,
MicrosoftCustomerAgreement: No description available. ,
EnterpriseAgreement: No description available. ,
MicrosoftOnlineServicesProgram: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
enrollmentDetails:
{
Description: The properties of an enrollment. ,
Required: False ,
}
string ,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing account. ,
Required: False ,
}
boolean ,
hasNoBillingProfiles:
{
Description: Indicates whether or not the billing account has any billing profiles. ,
Required: False ,
}
boolean ,
notificationEmailAddress:
{
Description: Notification email address for legacy account. Available for agreement type Microsoft Online Services Program. ,
Required: False ,
}
string ,
primaryBillingTenantId:
{
Description: The tenant that was used to set up the billing account. By default, only users from this tenant can get role assignments on the billing account and all purchases are provisioned in this tenant. ,
Required: False ,
}
string ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
string ,
registrationNumber:
{
Description: Describes the registration number of the organization linked with the billing account. ,
Required: False ,
}
string ,
billingRelationshipTypes:
{
Description: Identifies the billing relationships represented by a billing account. The billing relationship may be between Microsoft, the customer, and/or a third-party. ,
Required: False ,
}
[
string ,
]
,
qualifications:
{
Description: Qualifications for pricing on a billing account. Values may be Commercial, Education, Charity or Government. ,
Required: False ,
}
[
string ,
]
,
taxIds:
{
Description: A list of tax identifiers for the billing account. ,
Required: False ,
}
[
{
id:
{
Description: The id of the tax identifier. ,
Required: False ,
}
string ,
type:
{
Description: The type of the tax identifier. ,
Enum:
{
Other: No description available. ,
BrazilCcmId: No description available. ,
BrazilCnpjId: No description available. ,
BrazilCpfId: No description available. ,
CanadianFederalExempt: No description available. ,
CanadianProvinceExempt: No description available. ,
ExternalTaxation: No description available. ,
IndiaFederalTanId: No description available. ,
IndiaFederalServiceTaxId: No description available. ,
IndiaPanId: No description available. ,
IndiaStateCstId: No description available. ,
IndiaStateGstINId: No description available. ,
IndiaStateVatId: No description available. ,
IntlExempt: No description available. ,
USExempt: No description available. ,
VatId: No description available. ,
LoveCode: No description available. ,
MobileBarCode: No description available. ,
NationalIdentificationNumber: No description available. ,
PublicSectorId: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope of the tax identifier. ,
Required: False ,
}
string ,
country:
{
Description: The country of the tax identifier. ,
Required: False ,
}
string ,
status:
{
Description: The status of the tax identifier. ,
Enum:
{
Other: No description available. ,
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingAccounts_List (new)
Description :  Lists the billing accounts that a user has access to.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts
{
includeAll:
{
Description: When true, results will include Billing Accounts that the user does not have a direct role assignment on if the user has one of the following AAD roles: Global Administrator, Global Reader, Billing Administrator. ,
Required: False ,
}
boolean ,
includeAllWithoutBillingProfiles:
{
Description: When true, results will include Billing Accounts that are not fully created if the user has one of the following AAD roles: Global Administrator, Global Reader, Billing Administrator. ,
Required: False ,
}
boolean ,
includeDeleted:
{
Description: When true, results will include any billing accounts in a deleted state. ,
Required: False ,
}
boolean ,
includePendingAgreement:
{
Description: Includes billing accounts with agreement pending signature that the user has access to. ,
Required: False ,
}
boolean ,
includeResellee:
{
Description: Includes the customer's billing account of Microsoft Partner Agreement that the user has access to. ,
Required: False ,
}
boolean ,
legalOwnerTID:
{
Description: Must be combined with legalOwnerOID, results will only include Billing Accounts for whom is legally responsible for the Billing Accounts. Optional. ,
Required: False ,
}
string ,
legalOwnerOID:
{
Description: Must be combined with legalOwnerTID, results will only include Billing Accounts for whom is legally responsible for the Billing Accounts. Optional. ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
expand:
{
Description: Expand is allowed for SoldTo and EnrollmentDetails/PONumber. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A billing account. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatus:
{
Description: The current status of the billing account. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
UnderReview: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Extended: No description available. ,
Pending: No description available. ,
New: No description available. ,
Expired: No description available. ,
Terminated: No description available. ,
Transferred: No description available. ,
}
,
Required: False ,
}
enum ,
accountType:
{
Description: The type of customer. ,
Enum:
{
Other: No description available. ,
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
Reseller: No description available. ,
ClassicPartner: No description available. ,
Internal: No description available. ,
Tenant: No description available. ,
Business: No description available. ,
}
,
Required: False ,
}
enum ,
accountSubType:
{
Description: The tier of the account. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Individual: No description available. ,
Professional: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatusReasonCode:
{
Description: Reason for the specified billing account status. ,
Enum:
{
Other: No description available. ,
UnusualActivity: No description available. ,
ManuallyTerminated: No description available. ,
Expired: No description available. ,
Transferred: No description available. ,
TerminateProcessing: No description available. ,
}
,
Required: False ,
}
enum ,
agreementType:
{
Description: The type of agreement. ,
Enum:
{
Other: No description available. ,
MicrosoftCustomerAgreement: No description available. ,
EnterpriseAgreement: No description available. ,
MicrosoftOnlineServicesProgram: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
enrollmentDetails:
{
Description: The properties of an enrollment. ,
Required: False ,
}
string ,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing account. ,
Required: False ,
}
boolean ,
hasNoBillingProfiles:
{
Description: Indicates whether or not the billing account has any billing profiles. ,
Required: False ,
}
boolean ,
notificationEmailAddress:
{
Description: Notification email address for legacy account. Available for agreement type Microsoft Online Services Program. ,
Required: False ,
}
string ,
primaryBillingTenantId:
{
Description: The tenant that was used to set up the billing account. By default, only users from this tenant can get role assignments on the billing account and all purchases are provisioned in this tenant. ,
Required: False ,
}
string ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
string ,
registrationNumber:
{
Description: Describes the registration number of the organization linked with the billing account. ,
Required: False ,
}
string ,
billingRelationshipTypes:
{
Description: Identifies the billing relationships represented by a billing account. The billing relationship may be between Microsoft, the customer, and/or a third-party. ,
Required: False ,
}
[
string ,
]
,
qualifications:
{
Description: Qualifications for pricing on a billing account. Values may be Commercial, Education, Charity or Government. ,
Required: False ,
}
[
string ,
]
,
taxIds:
{
Description: A list of tax identifiers for the billing account. ,
Required: False ,
}
[
{
id:
{
Description: The id of the tax identifier. ,
Required: False ,
}
string ,
type:
{
Description: The type of the tax identifier. ,
Enum:
{
Other: No description available. ,
BrazilCcmId: No description available. ,
BrazilCnpjId: No description available. ,
BrazilCpfId: No description available. ,
CanadianFederalExempt: No description available. ,
CanadianProvinceExempt: No description available. ,
ExternalTaxation: No description available. ,
IndiaFederalTanId: No description available. ,
IndiaFederalServiceTaxId: No description available. ,
IndiaPanId: No description available. ,
IndiaStateCstId: No description available. ,
IndiaStateGstINId: No description available. ,
IndiaStateVatId: No description available. ,
IntlExempt: No description available. ,
USExempt: No description available. ,
VatId: No description available. ,
LoveCode: No description available. ,
MobileBarCode: No description available. ,
NationalIdentificationNumber: No description available. ,
PublicSectorId: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope of the tax identifier. ,
Required: False ,
}
string ,
country:
{
Description: The country of the tax identifier. ,
Required: False ,
}
string ,
status:
{
Description: The status of the tax identifier. ,
Enum:
{
Other: No description available. ,
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Address_Validate (new)
Description :  Validates an address. Use the operation to validate an address before using it as soldTo or a billTo address.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/validateAddress
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Address details. ,
Required: True ,
}
{
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. Optional for MCA Individual (Pay-as-you-go). ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO 3166-1 Alpha-2 format. ,
Required: True ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
firstName:
{
Description: First name. Optional for MCA Enterprise. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. Optional for MCA Enterprise. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
isValidAddress:
{
Description: Indicates if the address is incomplete. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
status:
{
Description: Status of the address validation. ,
Enum:
{
Other: No description available. ,
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
suggestedAddresses:
{
Description: The list of suggested addresses. ,
Required: False ,
}
[
{
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. Optional for MCA Individual (Pay-as-you-go). ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO 3166-1 Alpha-2 format. ,
Required: True ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
firstName:
{
Description: First name. Optional for MCA Enterprise. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. Optional for MCA Enterprise. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
isValidAddress:
{
Description: Indicates if the address is incomplete. ,
Required: False ,
}
boolean ,
}
,
]
,
validationMessage:
{
Description: Validation error message. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingPermissions_ListByBillingAccount (new)
Description :  Lists the billing permissions the caller has on a billing account.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingPermissions_ListByBillingProfile (new)
Description :  Lists the billing permissions the caller has on a billing profile.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingPermissions_CheckAccessByBillingProfile (new)
Description :  Provides a list of check access response objects for a billing profile.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/checkAccess
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The request object against which access of the caller will be checked. ,
Required: True ,
}
{
actions:
{
Description: List of actions passed in the request body against which the permissions will be checked. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
accessDecision:
{
Description: Access Decision, specifies access is allowed or not. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Gets or sets an action. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingPermissions_ListByCustomer (new)
Description :  Lists the billing permissions the caller has for a customer.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingPermissions_CheckAccessByCustomer (new)
Description :  Provides a list of check access response objects for a customer.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/checkAccess
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The request object against which access of the caller will be checked. ,
Required: True ,
}
{
actions:
{
Description: List of actions passed in the request body against which the permissions will be checked. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
accessDecision:
{
Description: Access Decision, specifies access is allowed or not. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Gets or sets an action. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingPermissions_ListByInvoiceSection (new)
Description :  Lists the billing permissions the caller has for an invoice section.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingPermissions_CheckAccessByInvoiceSection (new)
Description :  Provides a list of check access response objects for an invoice section.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/checkAccess
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The request object against which access of the caller will be checked. ,
Required: True ,
}
{
actions:
{
Description: List of actions passed in the request body against which the permissions will be checked. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
accessDecision:
{
Description: Access Decision, specifies access is allowed or not. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Gets or sets an action. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingPermissions_CheckAccessByBillingAccount (new)
Description :  Provides a list of check access response objects for a billing account.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/checkAccess
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The request object against which access of the caller will be checked. ,
Required: True ,
}
{
actions:
{
Description: List of actions passed in the request body against which the permissions will be checked. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
accessDecision:
{
Description: Access Decision, specifies access is allowed or not. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Gets or sets an action. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingPermissions_ListByCustomerAtBillingAccount (new)
Description :  Lists the billing permissions the caller has for a customer at billing account level.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingPermissions_ListByDepartment (new)
Description :  Lists the billing permissions the caller has for a department.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingPermissions_CheckAccessByDepartment (new)
Description :  Provides a list of check access response objects for a department.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/checkAccess
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
departmentName:
{
Description: The name of the department. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The request object against which access of the caller will be checked. ,
Required: True ,
}
{
actions:
{
Description: List of actions passed in the request body against which the permissions will be checked. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
accessDecision:
{
Description: Access Decision, specifies access is allowed or not. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Gets or sets an action. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingPermissions_ListByEnrollmentAccount (new)
Description :  Lists the billing permissions the caller has for an enrollment account.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingPermissions_CheckAccessByEnrollmentAccount (new)
Description :  Provides a list of check access response objects for an enrollment account.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/checkAccess
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
enrollmentAccountName:
{
Description: The name of the enrollment account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The request object against which access of the caller will be checked. ,
Required: True ,
}
{
actions:
{
Description: List of actions passed in the request body against which the permissions will be checked. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
accessDecision:
{
Description: Access Decision, specifies access is allowed or not. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Gets or sets an action. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingProfiles_ValidateDeleteEligibility (new)
Description :  Validates if the billing profile can be deleted. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
eligibilityStatus:
{
Description: Status describing if billing profile is eligible to be deleted. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
eligibilityDetails:
{
Description: Validation details of delete billing profile eligibility. ,
Required: False ,
}
[
{
code:
{
Description: Code of the delete invoice section eligibility response. ,
Enum:
{
None: No description available. ,
ActiveCredits: No description available. ,
ActiveCreditCard: No description available. ,
LastBillingProfile: No description available. ,
NotSupported: No description available. ,
OutstandingCharges: No description available. ,
PendingCharges: No description available. ,
ReservedInstances: No description available. ,
ActiveBillingSubscriptions: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingProfiles_Delete (new)
Description :  Deletes a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingProfiles_Get (new)
Description :  Gets a billing profile by its ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
billingRelationshipType:
{
Description: Identifies the billing relationship represented by the billing profile. The billing relationship may be between Microsoft, the customer, and/or a third-party. ,
Enum:
{
Other: No description available. ,
Direct: No description available. ,
IndirectCustomer: No description available. ,
IndirectPartner: No description available. ,
CSPPartner: No description available. ,
CSPCustomer: No description available. ,
}
,
Required: False ,
}
enum ,
billTo:
{
Description: Billing address. ,
Required: False ,
}
string ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Information about the enabled azure plans. ,
Required: False ,
}
[
{
productId:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
skuId:
{
Description: The ID that uniquely identifies a sku. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing profile. ,
Required: False ,
}
boolean ,
indirectRelationshipInfo:
{
Description: Identifies the billing profile that is linked to another billing profile in indirect purchase motion. ,
Required: False ,
}
string ,
invoiceDay:
{
Description: The day of the month when the invoice for the billing profile is generated. ,
Format: int32 ,
Required: False ,
}
integer ,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
invoiceRecipients:
{
Description: The list of email addresses to receive invoices by email for the billing profile. ,
Required: False ,
}
[
string ,
]
,
poNumber:
{
Description: The default purchase order number that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
shipTo:
{
Description: The default address where the products are shipped, or the services are being used. If a ship to is not specified for a product or a subscription, then this address will be used. ,
Required: False ,
}
string ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
string ,
spendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
spendingLimitDetails:
{
Description: The details of billing profile spending limit. ,
Required: False ,
}
[
{
amount:
{
Description: The initial amount for the billing profile. ,
Required: False ,
}
number ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
startDate:
{
Description: The date when this spending limit goes into effect. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date when this spending limit is no longer in effect. ,
Format: date-time ,
Required: False ,
}
string ,
type:
{
Description: The type of spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
FreeAccount: No description available. ,
Sandbox: No description available. ,
AzureForStudents: No description available. ,
AcademicSponsorship: No description available. ,
AzureConsumptionCredit: No description available. ,
AzurePassSponsorship: No description available. ,
MpnSponsorship: No description available. ,
MSDN: No description available. ,
NonProfitSponsorship: No description available. ,
Sponsorship: No description available. ,
StartupSponsorship: No description available. ,
AzureForStudentsStarter: No description available. ,
VisualStudio: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of current spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Active: No description available. ,
Expired: No description available. ,
LimitReached: No description available. ,
LimitRemoved: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
status:
{
Description: The status of the billing profile. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
statusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
targetClouds:
{
Description: Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. ,
Required: False ,
}
[
string ,
]
,
currentPaymentTerm:
{
Description: The current payment term of the billing profile. ,
Required: False ,
}
string ,
otherPaymentTerms:
{
Description: The other payment terms of the billing profile. ,
Required: False ,
}
[
{
term:
{
Description: Represents duration in netXX format. Always in days. ,
Required: False ,
}
string ,
startDate:
{
Description: The date on when the defined 'Payment Term' will be effective from and is always in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date on when the defined 'Payment Term' will end and is always in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
isDefault:
{
Description: Indicates payment term is the standard payment term. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingProfiles_CreateOrUpdate (new)
Description :  Creates or updates a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. If you are a MCA Individual (Pay-as-you-go) customer, then please use the Azure portal experience to create the billing profile.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: A billing profile. ,
Required: True ,
}
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
billingRelationshipType:
{
Description: Identifies the billing relationship represented by the billing profile. The billing relationship may be between Microsoft, the customer, and/or a third-party. ,
Enum:
{
Other: No description available. ,
Direct: No description available. ,
IndirectCustomer: No description available. ,
IndirectPartner: No description available. ,
CSPPartner: No description available. ,
CSPCustomer: No description available. ,
}
,
Required: False ,
}
enum ,
billTo:
{
Description: Billing address. ,
Required: False ,
}
string ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Information about the enabled azure plans. ,
Required: False ,
}
[
{
productId:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
skuId:
{
Description: The ID that uniquely identifies a sku. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing profile. ,
Required: False ,
}
boolean ,
indirectRelationshipInfo:
{
Description: Identifies the billing profile that is linked to another billing profile in indirect purchase motion. ,
Required: False ,
}
string ,
invoiceDay:
{
Description: The day of the month when the invoice for the billing profile is generated. ,
Format: int32 ,
Required: False ,
}
integer ,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
invoiceRecipients:
{
Description: The list of email addresses to receive invoices by email for the billing profile. ,
Required: False ,
}
[
string ,
]
,
poNumber:
{
Description: The default purchase order number that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
shipTo:
{
Description: The default address where the products are shipped, or the services are being used. If a ship to is not specified for a product or a subscription, then this address will be used. ,
Required: False ,
}
string ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
string ,
spendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
spendingLimitDetails:
{
Description: The details of billing profile spending limit. ,
Required: False ,
}
[
{
amount:
{
Description: The initial amount for the billing profile. ,
Required: False ,
}
number ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
startDate:
{
Description: The date when this spending limit goes into effect. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date when this spending limit is no longer in effect. ,
Format: date-time ,
Required: False ,
}
string ,
type:
{
Description: The type of spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
FreeAccount: No description available. ,
Sandbox: No description available. ,
AzureForStudents: No description available. ,
AcademicSponsorship: No description available. ,
AzureConsumptionCredit: No description available. ,
AzurePassSponsorship: No description available. ,
MpnSponsorship: No description available. ,
MSDN: No description available. ,
NonProfitSponsorship: No description available. ,
Sponsorship: No description available. ,
StartupSponsorship: No description available. ,
AzureForStudentsStarter: No description available. ,
VisualStudio: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of current spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Active: No description available. ,
Expired: No description available. ,
LimitReached: No description available. ,
LimitRemoved: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
status:
{
Description: The status of the billing profile. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
statusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
targetClouds:
{
Description: Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. ,
Required: False ,
}
[
string ,
]
,
currentPaymentTerm:
{
Description: The current payment term of the billing profile. ,
Required: False ,
}
string ,
otherPaymentTerms:
{
Description: The other payment terms of the billing profile. ,
Required: False ,
}
[
{
term:
{
Description: Represents duration in netXX format. Always in days. ,
Required: False ,
}
string ,
startDate:
{
Description: The date on when the defined 'Payment Term' will be effective from and is always in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date on when the defined 'Payment Term' will end and is always in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
isDefault:
{
Description: Indicates payment term is the standard payment term. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
billingRelationshipType:
{
Description: Identifies the billing relationship represented by the billing profile. The billing relationship may be between Microsoft, the customer, and/or a third-party. ,
Enum:
{
Other: No description available. ,
Direct: No description available. ,
IndirectCustomer: No description available. ,
IndirectPartner: No description available. ,
CSPPartner: No description available. ,
CSPCustomer: No description available. ,
}
,
Required: False ,
}
enum ,
billTo:
{
Description: Billing address. ,
Required: False ,
}
string ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Information about the enabled azure plans. ,
Required: False ,
}
[
{
productId:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
skuId:
{
Description: The ID that uniquely identifies a sku. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing profile. ,
Required: False ,
}
boolean ,
indirectRelationshipInfo:
{
Description: Identifies the billing profile that is linked to another billing profile in indirect purchase motion. ,
Required: False ,
}
string ,
invoiceDay:
{
Description: The day of the month when the invoice for the billing profile is generated. ,
Format: int32 ,
Required: False ,
}
integer ,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
invoiceRecipients:
{
Description: The list of email addresses to receive invoices by email for the billing profile. ,
Required: False ,
}
[
string ,
]
,
poNumber:
{
Description: The default purchase order number that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
shipTo:
{
Description: The default address where the products are shipped, or the services are being used. If a ship to is not specified for a product or a subscription, then this address will be used. ,
Required: False ,
}
string ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
string ,
spendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
spendingLimitDetails:
{
Description: The details of billing profile spending limit. ,
Required: False ,
}
[
{
amount:
{
Description: The initial amount for the billing profile. ,
Required: False ,
}
number ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
startDate:
{
Description: The date when this spending limit goes into effect. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date when this spending limit is no longer in effect. ,
Format: date-time ,
Required: False ,
}
string ,
type:
{
Description: The type of spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
FreeAccount: No description available. ,
Sandbox: No description available. ,
AzureForStudents: No description available. ,
AcademicSponsorship: No description available. ,
AzureConsumptionCredit: No description available. ,
AzurePassSponsorship: No description available. ,
MpnSponsorship: No description available. ,
MSDN: No description available. ,
NonProfitSponsorship: No description available. ,
Sponsorship: No description available. ,
StartupSponsorship: No description available. ,
AzureForStudentsStarter: No description available. ,
VisualStudio: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of current spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Active: No description available. ,
Expired: No description available. ,
LimitReached: No description available. ,
LimitRemoved: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
status:
{
Description: The status of the billing profile. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
statusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
targetClouds:
{
Description: Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. ,
Required: False ,
}
[
string ,
]
,
currentPaymentTerm:
{
Description: The current payment term of the billing profile. ,
Required: False ,
}
string ,
otherPaymentTerms:
{
Description: The other payment terms of the billing profile. ,
Required: False ,
}
[
{
term:
{
Description: Represents duration in netXX format. Always in days. ,
Required: False ,
}
string ,
startDate:
{
Description: The date on when the defined 'Payment Term' will be effective from and is always in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date on when the defined 'Payment Term' will end and is always in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
isDefault:
{
Description: Indicates payment term is the standard payment term. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
billingRelationshipType:
{
Description: Identifies the billing relationship represented by the billing profile. The billing relationship may be between Microsoft, the customer, and/or a third-party. ,
Enum:
{
Other: No description available. ,
Direct: No description available. ,
IndirectCustomer: No description available. ,
IndirectPartner: No description available. ,
CSPPartner: No description available. ,
CSPCustomer: No description available. ,
}
,
Required: False ,
}
enum ,
billTo:
{
Description: Billing address. ,
Required: False ,
}
string ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Information about the enabled azure plans. ,
Required: False ,
}
[
{
productId:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
skuId:
{
Description: The ID that uniquely identifies a sku. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing profile. ,
Required: False ,
}
boolean ,
indirectRelationshipInfo:
{
Description: Identifies the billing profile that is linked to another billing profile in indirect purchase motion. ,
Required: False ,
}
string ,
invoiceDay:
{
Description: The day of the month when the invoice for the billing profile is generated. ,
Format: int32 ,
Required: False ,
}
integer ,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
invoiceRecipients:
{
Description: The list of email addresses to receive invoices by email for the billing profile. ,
Required: False ,
}
[
string ,
]
,
poNumber:
{
Description: The default purchase order number that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
shipTo:
{
Description: The default address where the products are shipped, or the services are being used. If a ship to is not specified for a product or a subscription, then this address will be used. ,
Required: False ,
}
string ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
string ,
spendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
spendingLimitDetails:
{
Description: The details of billing profile spending limit. ,
Required: False ,
}
[
{
amount:
{
Description: The initial amount for the billing profile. ,
Required: False ,
}
number ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
startDate:
{
Description: The date when this spending limit goes into effect. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date when this spending limit is no longer in effect. ,
Format: date-time ,
Required: False ,
}
string ,
type:
{
Description: The type of spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
FreeAccount: No description available. ,
Sandbox: No description available. ,
AzureForStudents: No description available. ,
AcademicSponsorship: No description available. ,
AzureConsumptionCredit: No description available. ,
AzurePassSponsorship: No description available. ,
MpnSponsorship: No description available. ,
MSDN: No description available. ,
NonProfitSponsorship: No description available. ,
Sponsorship: No description available. ,
StartupSponsorship: No description available. ,
AzureForStudentsStarter: No description available. ,
VisualStudio: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of current spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Active: No description available. ,
Expired: No description available. ,
LimitReached: No description available. ,
LimitRemoved: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
status:
{
Description: The status of the billing profile. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
statusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
targetClouds:
{
Description: Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. ,
Required: False ,
}
[
string ,
]
,
currentPaymentTerm:
{
Description: The current payment term of the billing profile. ,
Required: False ,
}
string ,
otherPaymentTerms:
{
Description: The other payment terms of the billing profile. ,
Required: False ,
}
[
{
term:
{
Description: Represents duration in netXX format. Always in days. ,
Required: False ,
}
string ,
startDate:
{
Description: The date on when the defined 'Payment Term' will be effective from and is always in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date on when the defined 'Payment Term' will end and is always in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
isDefault:
{
Description: Indicates payment term is the standard payment term. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingProfiles_ListByBillingAccount (new)
Description :  Lists the billing profiles that a user has access to. The operation is supported for billing accounts with agreement of type Microsoft Customer Agreement and Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
includeDeleted:
{
Description: Can be used to get deleted billing profiles. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
billingRelationshipType:
{
Description: Identifies the billing relationship represented by the billing profile. The billing relationship may be between Microsoft, the customer, and/or a third-party. ,
Enum:
{
Other: No description available. ,
Direct: No description available. ,
IndirectCustomer: No description available. ,
IndirectPartner: No description available. ,
CSPPartner: No description available. ,
CSPCustomer: No description available. ,
}
,
Required: False ,
}
enum ,
billTo:
{
Description: Billing address. ,
Required: False ,
}
string ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Information about the enabled azure plans. ,
Required: False ,
}
[
{
productId:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
skuId:
{
Description: The ID that uniquely identifies a sku. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing profile. ,
Required: False ,
}
boolean ,
indirectRelationshipInfo:
{
Description: Identifies the billing profile that is linked to another billing profile in indirect purchase motion. ,
Required: False ,
}
string ,
invoiceDay:
{
Description: The day of the month when the invoice for the billing profile is generated. ,
Format: int32 ,
Required: False ,
}
integer ,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
invoiceRecipients:
{
Description: The list of email addresses to receive invoices by email for the billing profile. ,
Required: False ,
}
[
string ,
]
,
poNumber:
{
Description: The default purchase order number that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
shipTo:
{
Description: The default address where the products are shipped, or the services are being used. If a ship to is not specified for a product or a subscription, then this address will be used. ,
Required: False ,
}
string ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
string ,
spendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
spendingLimitDetails:
{
Description: The details of billing profile spending limit. ,
Required: False ,
}
[
{
amount:
{
Description: The initial amount for the billing profile. ,
Required: False ,
}
number ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
startDate:
{
Description: The date when this spending limit goes into effect. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date when this spending limit is no longer in effect. ,
Format: date-time ,
Required: False ,
}
string ,
type:
{
Description: The type of spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
FreeAccount: No description available. ,
Sandbox: No description available. ,
AzureForStudents: No description available. ,
AcademicSponsorship: No description available. ,
AzureConsumptionCredit: No description available. ,
AzurePassSponsorship: No description available. ,
MpnSponsorship: No description available. ,
MSDN: No description available. ,
NonProfitSponsorship: No description available. ,
Sponsorship: No description available. ,
StartupSponsorship: No description available. ,
AzureForStudentsStarter: No description available. ,
VisualStudio: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of current spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Active: No description available. ,
Expired: No description available. ,
LimitReached: No description available. ,
LimitRemoved: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
status:
{
Description: The status of the billing profile. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
statusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
targetClouds:
{
Description: Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. ,
Required: False ,
}
[
string ,
]
,
currentPaymentTerm:
{
Description: The current payment term of the billing profile. ,
Required: False ,
}
string ,
otherPaymentTerms:
{
Description: The other payment terms of the billing profile. ,
Required: False ,
}
[
{
term:
{
Description: Represents duration in netXX format. Always in days. ,
Required: False ,
}
string ,
startDate:
{
Description: The date on when the defined 'Payment Term' will be effective from and is always in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date on when the defined 'Payment Term' will end and is always in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
isDefault:
{
Description: Indicates payment term is the standard payment term. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingProperty_Get (new)
Description :  Gets the billing properties for a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingProperty/default
{
subscriptionId:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: True ,
}
string ,
includeBillingCountry:
{
Description: A flag that specifies whether or not to include billing country. ,
Required: False ,
}
boolean ,
includeTransitionStatus:
{
Description: A flag that specifies whether or not to include transition status for billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A billing property. ,
Required: False ,
}
{
billingAccountAgreementType:
{
Description: The type of agreement. ,
Enum:
{
Other: No description available. ,
MicrosoftCustomerAgreement: No description available. ,
EnterpriseAgreement: No description available. ,
MicrosoftOnlineServicesProgram: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
accountAdminNotificationEmailAddress:
{
Description: Notification email address for legacy account. Available for agreement type Microsoft Online Services Program. ,
Required: False ,
}
string ,
billingAccountSoldToCountry:
{
Description: The country of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
string ,
billingAccountStatus:
{
Description: The current status of the billing account. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
UnderReview: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Extended: No description available. ,
Pending: No description available. ,
New: No description available. ,
Expired: No description available. ,
Terminated: No description available. ,
Transferred: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountStatusReasonCode:
{
Description: Reason for the specified billing account status. ,
Enum:
{
Other: No description available. ,
UnusualActivity: No description available. ,
ManuallyTerminated: No description available. ,
Expired: No description available. ,
Transferred: No description available. ,
TerminateProcessing: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountType:
{
Description: The type of customer. ,
Enum:
{
Other: No description available. ,
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
Reseller: No description available. ,
ClassicPartner: No description available. ,
Internal: No description available. ,
Tenant: No description available. ,
Business: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountSubType:
{
Description: The tier of the account. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Individual: No description available. ,
Professional: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
billingCurrency:
{
Description: The billing currency for the subscription. Available for billing accounts with agreement type Enterprise Agreement ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileSpendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfileSpendingLimitDetails:
{
Description: The details of billing profile spending limit. ,
Required: False ,
}
[
{
amount:
{
Description: The initial amount for the billing profile. ,
Required: False ,
}
number ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
startDate:
{
Description: The date when this spending limit goes into effect. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date when this spending limit is no longer in effect. ,
Format: date-time ,
Required: False ,
}
string ,
type:
{
Description: The type of spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
FreeAccount: No description available. ,
Sandbox: No description available. ,
AzureForStudents: No description available. ,
AcademicSponsorship: No description available. ,
AzureConsumptionCredit: No description available. ,
AzurePassSponsorship: No description available. ,
MpnSponsorship: No description available. ,
MSDN: No description available. ,
NonProfitSponsorship: No description available. ,
Sponsorship: No description available. ,
StartupSponsorship: No description available. ,
AzureForStudentsStarter: No description available. ,
VisualStudio: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of current spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Active: No description available. ,
Expired: No description available. ,
LimitReached: No description available. ,
LimitRemoved: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
billingProfileStatus:
{
Description: The status of the billing profile. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfileStatusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfilePaymentMethodFamily:
{
Description: The payment method family of the primary payment method for the billing profile. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfilePaymentMethodType:
{
Description: The payment method type of the primary payment method for the billing profile. ,
Required: False ,
}
string ,
billingTenantId:
{
Description: The Azure AD tenant ID of the billing account for the subscription. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center applied to the subscription. Available for agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. This property can be updated via patch. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerStatus:
{
Description: Identifies the status of an customer. This is an upcoming property that will be populated in the future. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionStatus:
{
Description: Identifies the status of an invoice section. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
Disabled: No description available. ,
UnderReview: No description available. ,
Warned: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceSectionStatusReasonCode:
{
Description: Reason for the specified invoice section status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
isTransitionedBillingAccount:
{
Description: Specifies if the billing account for the subscription is transitioned from a Microsoft Online Service Program to a Microsoft Customer Agreement (MCA) account. Will be present and value will be true if its a transitioned billing account. ,
Required: False ,
}
boolean ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
skuId:
{
Description: The ID that uniquely identifies a sku. ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: The subscription status. ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionBillingStatusDetails:
{
Description: The reason codes for the subscription status. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
subscriptionBillingType:
{
Description: The type of billing subscription. ,
Enum:
{
None: No description available. ,
Benefit: No description available. ,
Free: No description available. ,
Paid: No description available. ,
PrePaid: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionServiceUsageAddress:
{
Description: The address of the individual or organization where service subscription is being used. Available for agreement type Microsoft Online Services Program. This property can be updated via patch. ,
Required: False ,
}
string ,
subscriptionWorkloadType:
{
Description: The Azure workload type of the subscription. ,
Enum:
{
None: No description available. ,
Production: No description available. ,
DevTest: No description available. ,
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDetails:
{
Description: The enrollment details for the subscription. Available for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
isAccountAdmin:
{
Description: Indicates whether user is the account admin. ,
Required: False ,
}
boolean ,
productId:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
productName:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingProperty_Update (new)
Description :  Updates the billing property of a subscription. Currently, cost center can be updated for billing accounts with agreement type Microsoft Customer Agreement and subscription service usage address can be updated for billing accounts with agreement type Microsoft Online Service Program.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingProperty/default
{
subscriptionId:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: A billing property. ,
Required: True ,
}
{
properties:
{
Description: A billing property. ,
Required: False ,
}
{
billingAccountAgreementType:
{
Description: The type of agreement. ,
Enum:
{
Other: No description available. ,
MicrosoftCustomerAgreement: No description available. ,
EnterpriseAgreement: No description available. ,
MicrosoftOnlineServicesProgram: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
accountAdminNotificationEmailAddress:
{
Description: Notification email address for legacy account. Available for agreement type Microsoft Online Services Program. ,
Required: False ,
}
string ,
billingAccountSoldToCountry:
{
Description: The country of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
string ,
billingAccountStatus:
{
Description: The current status of the billing account. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
UnderReview: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Extended: No description available. ,
Pending: No description available. ,
New: No description available. ,
Expired: No description available. ,
Terminated: No description available. ,
Transferred: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountStatusReasonCode:
{
Description: Reason for the specified billing account status. ,
Enum:
{
Other: No description available. ,
UnusualActivity: No description available. ,
ManuallyTerminated: No description available. ,
Expired: No description available. ,
Transferred: No description available. ,
TerminateProcessing: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountType:
{
Description: The type of customer. ,
Enum:
{
Other: No description available. ,
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
Reseller: No description available. ,
ClassicPartner: No description available. ,
Internal: No description available. ,
Tenant: No description available. ,
Business: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountSubType:
{
Description: The tier of the account. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Individual: No description available. ,
Professional: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
billingCurrency:
{
Description: The billing currency for the subscription. Available for billing accounts with agreement type Enterprise Agreement ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileSpendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfileSpendingLimitDetails:
{
Description: The details of billing profile spending limit. ,
Required: False ,
}
[
{
amount:
{
Description: The initial amount for the billing profile. ,
Required: False ,
}
number ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
startDate:
{
Description: The date when this spending limit goes into effect. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date when this spending limit is no longer in effect. ,
Format: date-time ,
Required: False ,
}
string ,
type:
{
Description: The type of spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
FreeAccount: No description available. ,
Sandbox: No description available. ,
AzureForStudents: No description available. ,
AcademicSponsorship: No description available. ,
AzureConsumptionCredit: No description available. ,
AzurePassSponsorship: No description available. ,
MpnSponsorship: No description available. ,
MSDN: No description available. ,
NonProfitSponsorship: No description available. ,
Sponsorship: No description available. ,
StartupSponsorship: No description available. ,
AzureForStudentsStarter: No description available. ,
VisualStudio: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of current spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Active: No description available. ,
Expired: No description available. ,
LimitReached: No description available. ,
LimitRemoved: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
billingProfileStatus:
{
Description: The status of the billing profile. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfileStatusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfilePaymentMethodFamily:
{
Description: The payment method family of the primary payment method for the billing profile. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfilePaymentMethodType:
{
Description: The payment method type of the primary payment method for the billing profile. ,
Required: False ,
}
string ,
billingTenantId:
{
Description: The Azure AD tenant ID of the billing account for the subscription. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center applied to the subscription. Available for agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. This property can be updated via patch. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerStatus:
{
Description: Identifies the status of an customer. This is an upcoming property that will be populated in the future. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionStatus:
{
Description: Identifies the status of an invoice section. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
Disabled: No description available. ,
UnderReview: No description available. ,
Warned: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceSectionStatusReasonCode:
{
Description: Reason for the specified invoice section status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
isTransitionedBillingAccount:
{
Description: Specifies if the billing account for the subscription is transitioned from a Microsoft Online Service Program to a Microsoft Customer Agreement (MCA) account. Will be present and value will be true if its a transitioned billing account. ,
Required: False ,
}
boolean ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
skuId:
{
Description: The ID that uniquely identifies a sku. ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: The subscription status. ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionBillingStatusDetails:
{
Description: The reason codes for the subscription status. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
subscriptionBillingType:
{
Description: The type of billing subscription. ,
Enum:
{
None: No description available. ,
Benefit: No description available. ,
Free: No description available. ,
Paid: No description available. ,
PrePaid: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionServiceUsageAddress:
{
Description: The address of the individual or organization where service subscription is being used. Available for agreement type Microsoft Online Services Program. This property can be updated via patch. ,
Required: False ,
}
string ,
subscriptionWorkloadType:
{
Description: The Azure workload type of the subscription. ,
Enum:
{
None: No description available. ,
Production: No description available. ,
DevTest: No description available. ,
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDetails:
{
Description: The enrollment details for the subscription. Available for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
isAccountAdmin:
{
Description: Indicates whether user is the account admin. ,
Required: False ,
}
boolean ,
productId:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
productName:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A billing property. ,
Required: False ,
}
{
billingAccountAgreementType:
{
Description: The type of agreement. ,
Enum:
{
Other: No description available. ,
MicrosoftCustomerAgreement: No description available. ,
EnterpriseAgreement: No description available. ,
MicrosoftOnlineServicesProgram: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
accountAdminNotificationEmailAddress:
{
Description: Notification email address for legacy account. Available for agreement type Microsoft Online Services Program. ,
Required: False ,
}
string ,
billingAccountSoldToCountry:
{
Description: The country of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
string ,
billingAccountStatus:
{
Description: The current status of the billing account. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
UnderReview: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Extended: No description available. ,
Pending: No description available. ,
New: No description available. ,
Expired: No description available. ,
Terminated: No description available. ,
Transferred: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountStatusReasonCode:
{
Description: Reason for the specified billing account status. ,
Enum:
{
Other: No description available. ,
UnusualActivity: No description available. ,
ManuallyTerminated: No description available. ,
Expired: No description available. ,
Transferred: No description available. ,
TerminateProcessing: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountType:
{
Description: The type of customer. ,
Enum:
{
Other: No description available. ,
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
Reseller: No description available. ,
ClassicPartner: No description available. ,
Internal: No description available. ,
Tenant: No description available. ,
Business: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountSubType:
{
Description: The tier of the account. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Individual: No description available. ,
Professional: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
billingCurrency:
{
Description: The billing currency for the subscription. Available for billing accounts with agreement type Enterprise Agreement ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileSpendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfileSpendingLimitDetails:
{
Description: The details of billing profile spending limit. ,
Required: False ,
}
[
{
amount:
{
Description: The initial amount for the billing profile. ,
Required: False ,
}
number ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
startDate:
{
Description: The date when this spending limit goes into effect. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date when this spending limit is no longer in effect. ,
Format: date-time ,
Required: False ,
}
string ,
type:
{
Description: The type of spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
FreeAccount: No description available. ,
Sandbox: No description available. ,
AzureForStudents: No description available. ,
AcademicSponsorship: No description available. ,
AzureConsumptionCredit: No description available. ,
AzurePassSponsorship: No description available. ,
MpnSponsorship: No description available. ,
MSDN: No description available. ,
NonProfitSponsorship: No description available. ,
Sponsorship: No description available. ,
StartupSponsorship: No description available. ,
AzureForStudentsStarter: No description available. ,
VisualStudio: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of current spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Active: No description available. ,
Expired: No description available. ,
LimitReached: No description available. ,
LimitRemoved: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
billingProfileStatus:
{
Description: The status of the billing profile. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfileStatusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfilePaymentMethodFamily:
{
Description: The payment method family of the primary payment method for the billing profile. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfilePaymentMethodType:
{
Description: The payment method type of the primary payment method for the billing profile. ,
Required: False ,
}
string ,
billingTenantId:
{
Description: The Azure AD tenant ID of the billing account for the subscription. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center applied to the subscription. Available for agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. This property can be updated via patch. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerStatus:
{
Description: Identifies the status of an customer. This is an upcoming property that will be populated in the future. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionStatus:
{
Description: Identifies the status of an invoice section. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
Disabled: No description available. ,
UnderReview: No description available. ,
Warned: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceSectionStatusReasonCode:
{
Description: Reason for the specified invoice section status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
isTransitionedBillingAccount:
{
Description: Specifies if the billing account for the subscription is transitioned from a Microsoft Online Service Program to a Microsoft Customer Agreement (MCA) account. Will be present and value will be true if its a transitioned billing account. ,
Required: False ,
}
boolean ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
skuId:
{
Description: The ID that uniquely identifies a sku. ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: The subscription status. ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionBillingStatusDetails:
{
Description: The reason codes for the subscription status. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
subscriptionBillingType:
{
Description: The type of billing subscription. ,
Enum:
{
None: No description available. ,
Benefit: No description available. ,
Free: No description available. ,
Paid: No description available. ,
PrePaid: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionServiceUsageAddress:
{
Description: The address of the individual or organization where service subscription is being used. Available for agreement type Microsoft Online Services Program. This property can be updated via patch. ,
Required: False ,
}
string ,
subscriptionWorkloadType:
{
Description: The Azure workload type of the subscription. ,
Enum:
{
None: No description available. ,
Production: No description available. ,
DevTest: No description available. ,
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDetails:
{
Description: The enrollment details for the subscription. Available for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
isAccountAdmin:
{
Description: Indicates whether user is the account admin. ,
Required: False ,
}
boolean ,
productId:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
productName:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRequests_ListByBillingProfile (new)
Description :  The list of billing requests submitted for the billing profile.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRequests
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
additionalInformation:
{
Description: Additional information for the billing request. ,
Required: False ,
}
object ,
reviewedBy:
{
Description: The principal of the request reviewer. Will only be set if request is approved. ,
Required: False ,
}
string ,
reviewalDate:
{
Description: The date and time when the request was reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingAccountPrimaryBillingTenantId:
{
Description: The primary tenant ID of the billing account for which the billing request was submitted. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
createdBy:
{
Description: The principal of the entity who created the request. ,
Required: False ,
}
string ,
creationDate:
{
Description: The date and time when the request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date and time when the request expires. ,
Format: date-time ,
Required: False ,
}
string ,
decisionReason:
{
Description: The reason to approve or decline the request. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The fully qualified ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionDisplayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
justification:
{
Description: Justification for submitting request. ,
Required: False ,
}
string ,
recipients:
{
Description: The recipients of the billing request. ,
Required: False ,
}
[
{
tenantId:
{
Description: The tenant id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
upn:
{
Description: The user principal name of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
}
,
]
,
requestScope:
{
Description: The billing scope for which the request was submitted (ex. '/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}'). ,
Required: False ,
}
string ,
billingScope:
{
Description: The billing scope for which the request will be applied. This is a read only property derived by the service. ,
Required: False ,
}
string ,
status:
{
Description: Status of billing request. ,
Enum:
{
Other: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Declined: No description available. ,
Cancelled: No description available. ,
Completed: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type of billing request. ,
Enum:
{
Other: No description available. ,
InvoiceAccess: No description available. ,
ProvisioningAccess: No description available. ,
RoleAssignment: No description available. ,
UpdateBillingPolicy: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedBy:
{
Description: The principal of the entity who last updated the request. ,
Required: False ,
}
string ,
lastUpdatedDate:
{
Description: Date and time of last update. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRequests_ListByCustomer (new)
Description :  The list of billing requests submitted for the customer.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/billingRequests
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
additionalInformation:
{
Description: Additional information for the billing request. ,
Required: False ,
}
object ,
reviewedBy:
{
Description: The principal of the request reviewer. Will only be set if request is approved. ,
Required: False ,
}
string ,
reviewalDate:
{
Description: The date and time when the request was reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingAccountPrimaryBillingTenantId:
{
Description: The primary tenant ID of the billing account for which the billing request was submitted. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
createdBy:
{
Description: The principal of the entity who created the request. ,
Required: False ,
}
string ,
creationDate:
{
Description: The date and time when the request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date and time when the request expires. ,
Format: date-time ,
Required: False ,
}
string ,
decisionReason:
{
Description: The reason to approve or decline the request. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The fully qualified ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionDisplayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
justification:
{
Description: Justification for submitting request. ,
Required: False ,
}
string ,
recipients:
{
Description: The recipients of the billing request. ,
Required: False ,
}
[
{
tenantId:
{
Description: The tenant id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
upn:
{
Description: The user principal name of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
}
,
]
,
requestScope:
{
Description: The billing scope for which the request was submitted (ex. '/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}'). ,
Required: False ,
}
string ,
billingScope:
{
Description: The billing scope for which the request will be applied. This is a read only property derived by the service. ,
Required: False ,
}
string ,
status:
{
Description: Status of billing request. ,
Enum:
{
Other: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Declined: No description available. ,
Cancelled: No description available. ,
Completed: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type of billing request. ,
Enum:
{
Other: No description available. ,
InvoiceAccess: No description available. ,
ProvisioningAccess: No description available. ,
RoleAssignment: No description available. ,
UpdateBillingPolicy: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedBy:
{
Description: The principal of the entity who last updated the request. ,
Required: False ,
}
string ,
lastUpdatedDate:
{
Description: Date and time of last update. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRequests_ListByInvoiceSection (new)
Description :  The list of billing requests submitted for the invoice section.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRequests
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
additionalInformation:
{
Description: Additional information for the billing request. ,
Required: False ,
}
object ,
reviewedBy:
{
Description: The principal of the request reviewer. Will only be set if request is approved. ,
Required: False ,
}
string ,
reviewalDate:
{
Description: The date and time when the request was reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingAccountPrimaryBillingTenantId:
{
Description: The primary tenant ID of the billing account for which the billing request was submitted. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
createdBy:
{
Description: The principal of the entity who created the request. ,
Required: False ,
}
string ,
creationDate:
{
Description: The date and time when the request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date and time when the request expires. ,
Format: date-time ,
Required: False ,
}
string ,
decisionReason:
{
Description: The reason to approve or decline the request. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The fully qualified ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionDisplayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
justification:
{
Description: Justification for submitting request. ,
Required: False ,
}
string ,
recipients:
{
Description: The recipients of the billing request. ,
Required: False ,
}
[
{
tenantId:
{
Description: The tenant id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
upn:
{
Description: The user principal name of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
}
,
]
,
requestScope:
{
Description: The billing scope for which the request was submitted (ex. '/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}'). ,
Required: False ,
}
string ,
billingScope:
{
Description: The billing scope for which the request will be applied. This is a read only property derived by the service. ,
Required: False ,
}
string ,
status:
{
Description: Status of billing request. ,
Enum:
{
Other: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Declined: No description available. ,
Cancelled: No description available. ,
Completed: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type of billing request. ,
Enum:
{
Other: No description available. ,
InvoiceAccess: No description available. ,
ProvisioningAccess: No description available. ,
RoleAssignment: No description available. ,
UpdateBillingPolicy: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedBy:
{
Description: The principal of the entity who last updated the request. ,
Required: False ,
}
string ,
lastUpdatedDate:
{
Description: Date and time of last update. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRequests_ListByBillingAccount (new)
Description :  The list of billing requests submitted for the billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRequests
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
additionalInformation:
{
Description: Additional information for the billing request. ,
Required: False ,
}
object ,
reviewedBy:
{
Description: The principal of the request reviewer. Will only be set if request is approved. ,
Required: False ,
}
string ,
reviewalDate:
{
Description: The date and time when the request was reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingAccountPrimaryBillingTenantId:
{
Description: The primary tenant ID of the billing account for which the billing request was submitted. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
createdBy:
{
Description: The principal of the entity who created the request. ,
Required: False ,
}
string ,
creationDate:
{
Description: The date and time when the request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date and time when the request expires. ,
Format: date-time ,
Required: False ,
}
string ,
decisionReason:
{
Description: The reason to approve or decline the request. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The fully qualified ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionDisplayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
justification:
{
Description: Justification for submitting request. ,
Required: False ,
}
string ,
recipients:
{
Description: The recipients of the billing request. ,
Required: False ,
}
[
{
tenantId:
{
Description: The tenant id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
upn:
{
Description: The user principal name of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
}
,
]
,
requestScope:
{
Description: The billing scope for which the request was submitted (ex. '/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}'). ,
Required: False ,
}
string ,
billingScope:
{
Description: The billing scope for which the request will be applied. This is a read only property derived by the service. ,
Required: False ,
}
string ,
status:
{
Description: Status of billing request. ,
Enum:
{
Other: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Declined: No description available. ,
Cancelled: No description available. ,
Completed: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type of billing request. ,
Enum:
{
Other: No description available. ,
InvoiceAccess: No description available. ,
ProvisioningAccess: No description available. ,
RoleAssignment: No description available. ,
UpdateBillingPolicy: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedBy:
{
Description: The principal of the entity who last updated the request. ,
Required: False ,
}
string ,
lastUpdatedDate:
{
Description: Date and time of last update. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRequests_Get (new)
Description :  Gets a billing request by its ID.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingRequests/{billingRequestName}
{
billingRequestName:
{
Description: The ID that uniquely identifies a billing request. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
additionalInformation:
{
Description: Additional information for the billing request. ,
Required: False ,
}
object ,
reviewedBy:
{
Description: The principal of the request reviewer. Will only be set if request is approved. ,
Required: False ,
}
string ,
reviewalDate:
{
Description: The date and time when the request was reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingAccountPrimaryBillingTenantId:
{
Description: The primary tenant ID of the billing account for which the billing request was submitted. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
createdBy:
{
Description: The principal of the entity who created the request. ,
Required: False ,
}
string ,
creationDate:
{
Description: The date and time when the request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date and time when the request expires. ,
Format: date-time ,
Required: False ,
}
string ,
decisionReason:
{
Description: The reason to approve or decline the request. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The fully qualified ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionDisplayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
justification:
{
Description: Justification for submitting request. ,
Required: False ,
}
string ,
recipients:
{
Description: The recipients of the billing request. ,
Required: False ,
}
[
{
tenantId:
{
Description: The tenant id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
upn:
{
Description: The user principal name of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
}
,
]
,
requestScope:
{
Description: The billing scope for which the request was submitted (ex. '/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}'). ,
Required: False ,
}
string ,
billingScope:
{
Description: The billing scope for which the request will be applied. This is a read only property derived by the service. ,
Required: False ,
}
string ,
status:
{
Description: Status of billing request. ,
Enum:
{
Other: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Declined: No description available. ,
Cancelled: No description available. ,
Completed: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type of billing request. ,
Enum:
{
Other: No description available. ,
InvoiceAccess: No description available. ,
ProvisioningAccess: No description available. ,
RoleAssignment: No description available. ,
UpdateBillingPolicy: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedBy:
{
Description: The principal of the entity who last updated the request. ,
Required: False ,
}
string ,
lastUpdatedDate:
{
Description: Date and time of last update. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRequests_CreateOrUpdate (new)
Description :  Create or update a billing request.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingRequests/{billingRequestName}
{
billingRequestName:
{
Description: The ID that uniquely identifies a billing request. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests. ,
Required: True ,
}
{
properties:
{
Description: A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
additionalInformation:
{
Description: Additional information for the billing request. ,
Required: False ,
}
object ,
reviewedBy:
{
Description: The principal of the request reviewer. Will only be set if request is approved. ,
Required: False ,
}
string ,
reviewalDate:
{
Description: The date and time when the request was reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingAccountPrimaryBillingTenantId:
{
Description: The primary tenant ID of the billing account for which the billing request was submitted. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
createdBy:
{
Description: The principal of the entity who created the request. ,
Required: False ,
}
string ,
creationDate:
{
Description: The date and time when the request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date and time when the request expires. ,
Format: date-time ,
Required: False ,
}
string ,
decisionReason:
{
Description: The reason to approve or decline the request. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The fully qualified ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionDisplayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
justification:
{
Description: Justification for submitting request. ,
Required: False ,
}
string ,
recipients:
{
Description: The recipients of the billing request. ,
Required: False ,
}
[
{
tenantId:
{
Description: The tenant id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
upn:
{
Description: The user principal name of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
}
,
]
,
requestScope:
{
Description: The billing scope for which the request was submitted (ex. '/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}'). ,
Required: False ,
}
string ,
billingScope:
{
Description: The billing scope for which the request will be applied. This is a read only property derived by the service. ,
Required: False ,
}
string ,
status:
{
Description: Status of billing request. ,
Enum:
{
Other: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Declined: No description available. ,
Cancelled: No description available. ,
Completed: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type of billing request. ,
Enum:
{
Other: No description available. ,
InvoiceAccess: No description available. ,
ProvisioningAccess: No description available. ,
RoleAssignment: No description available. ,
UpdateBillingPolicy: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedBy:
{
Description: The principal of the entity who last updated the request. ,
Required: False ,
}
string ,
lastUpdatedDate:
{
Description: Date and time of last update. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
additionalInformation:
{
Description: Additional information for the billing request. ,
Required: False ,
}
object ,
reviewedBy:
{
Description: The principal of the request reviewer. Will only be set if request is approved. ,
Required: False ,
}
string ,
reviewalDate:
{
Description: The date and time when the request was reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingAccountPrimaryBillingTenantId:
{
Description: The primary tenant ID of the billing account for which the billing request was submitted. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
createdBy:
{
Description: The principal of the entity who created the request. ,
Required: False ,
}
string ,
creationDate:
{
Description: The date and time when the request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date and time when the request expires. ,
Format: date-time ,
Required: False ,
}
string ,
decisionReason:
{
Description: The reason to approve or decline the request. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The fully qualified ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionDisplayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
justification:
{
Description: Justification for submitting request. ,
Required: False ,
}
string ,
recipients:
{
Description: The recipients of the billing request. ,
Required: False ,
}
[
{
tenantId:
{
Description: The tenant id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
upn:
{
Description: The user principal name of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
}
,
]
,
requestScope:
{
Description: The billing scope for which the request was submitted (ex. '/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}'). ,
Required: False ,
}
string ,
billingScope:
{
Description: The billing scope for which the request will be applied. This is a read only property derived by the service. ,
Required: False ,
}
string ,
status:
{
Description: Status of billing request. ,
Enum:
{
Other: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Declined: No description available. ,
Cancelled: No description available. ,
Completed: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type of billing request. ,
Enum:
{
Other: No description available. ,
InvoiceAccess: No description available. ,
ProvisioningAccess: No description available. ,
RoleAssignment: No description available. ,
UpdateBillingPolicy: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedBy:
{
Description: The principal of the entity who last updated the request. ,
Required: False ,
}
string ,
lastUpdatedDate:
{
Description: Date and time of last update. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location: string ,
retry-after: integer ,
}
,
$schema:
{
Description: A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests. ,
}
{
properties:
{
Description: A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
additionalInformation:
{
Description: Additional information for the billing request. ,
Required: False ,
}
object ,
reviewedBy:
{
Description: The principal of the request reviewer. Will only be set if request is approved. ,
Required: False ,
}
string ,
reviewalDate:
{
Description: The date and time when the request was reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingAccountPrimaryBillingTenantId:
{
Description: The primary tenant ID of the billing account for which the billing request was submitted. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
createdBy:
{
Description: The principal of the entity who created the request. ,
Required: False ,
}
string ,
creationDate:
{
Description: The date and time when the request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date and time when the request expires. ,
Format: date-time ,
Required: False ,
}
string ,
decisionReason:
{
Description: The reason to approve or decline the request. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The fully qualified ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionDisplayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
justification:
{
Description: Justification for submitting request. ,
Required: False ,
}
string ,
recipients:
{
Description: The recipients of the billing request. ,
Required: False ,
}
[
{
tenantId:
{
Description: The tenant id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
upn:
{
Description: The user principal name of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
}
,
]
,
requestScope:
{
Description: The billing scope for which the request was submitted (ex. '/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}'). ,
Required: False ,
}
string ,
billingScope:
{
Description: The billing scope for which the request will be applied. This is a read only property derived by the service. ,
Required: False ,
}
string ,
status:
{
Description: Status of billing request. ,
Enum:
{
Other: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Declined: No description available. ,
Cancelled: No description available. ,
Completed: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type of billing request. ,
Enum:
{
Other: No description available. ,
InvoiceAccess: No description available. ,
ProvisioningAccess: No description available. ,
RoleAssignment: No description available. ,
UpdateBillingPolicy: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedBy:
{
Description: The principal of the entity who last updated the request. ,
Required: False ,
}
string ,
lastUpdatedDate:
{
Description: Date and time of last update. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRequests_ListByUser (new)
Description :  The list of billing requests submitted by a user.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingRequests
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
additionalInformation:
{
Description: Additional information for the billing request. ,
Required: False ,
}
object ,
reviewedBy:
{
Description: The principal of the request reviewer. Will only be set if request is approved. ,
Required: False ,
}
string ,
reviewalDate:
{
Description: The date and time when the request was reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingAccountPrimaryBillingTenantId:
{
Description: The primary tenant ID of the billing account for which the billing request was submitted. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
createdBy:
{
Description: The principal of the entity who created the request. ,
Required: False ,
}
string ,
creationDate:
{
Description: The date and time when the request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date and time when the request expires. ,
Format: date-time ,
Required: False ,
}
string ,
decisionReason:
{
Description: The reason to approve or decline the request. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The fully qualified ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionDisplayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
justification:
{
Description: Justification for submitting request. ,
Required: False ,
}
string ,
recipients:
{
Description: The recipients of the billing request. ,
Required: False ,
}
[
{
tenantId:
{
Description: The tenant id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
upn:
{
Description: The user principal name of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
}
,
]
,
requestScope:
{
Description: The billing scope for which the request was submitted (ex. '/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}'). ,
Required: False ,
}
string ,
billingScope:
{
Description: The billing scope for which the request will be applied. This is a read only property derived by the service. ,
Required: False ,
}
string ,
status:
{
Description: Status of billing request. ,
Enum:
{
Other: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Declined: No description available. ,
Cancelled: No description available. ,
Completed: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type of billing request. ,
Enum:
{
Other: No description available. ,
InvoiceAccess: No description available. ,
ProvisioningAccess: No description available. ,
RoleAssignment: No description available. ,
UpdateBillingPolicy: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedBy:
{
Description: The principal of the entity who last updated the request. ,
Required: False ,
}
string ,
lastUpdatedDate:
{
Description: Date and time of last update. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_DeleteByBillingProfile (new)
Description :  Deletes a role assignment on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_ListByBillingProfile (new)
Description :  Lists the role assignments for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleAssignments
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_CreateByBillingProfile (new)
Description :  Adds a role assignment on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/createBillingRoleAssignment
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of the billing role assignment. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_DeleteByCustomer (new)
Description :  Deletes a role assignment on a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_GetByCustomer (new)
Description :  Gets a role assignment for the caller on a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_ListByCustomer (new)
Description :  Lists the role assignments for the caller on customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/billingRoleAssignments
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_CreateByCustomer (new)
Description :  Adds a role assignment on a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/createBillingRoleAssignment
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of the billing role assignment. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_ResolveByCustomer (new)
Description :  Lists the role assignments for the caller on a customer while fetching user info for each role assignment. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/resolveBillingRoleAssignments
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
resolveScopeDisplayNames:
{
Description: Resolves the scope display name for each of the role assignments. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_DeleteByInvoiceSection (new)
Description :  Deletes a role assignment on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleAssignments
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_CreateByInvoiceSection (new)
Description :  Adds a role assignment on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/createBillingRoleAssignment
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of the billing role assignment. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_ResolveByInvoiceSection (new)
Description :  Lists the role assignments for the caller on an invoice section while fetching user info for each role assignment. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/resolveBillingRoleAssignments
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
resolveScopeDisplayNames:
{
Description: Resolves the scope display name for each of the role assignments. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_ResolveByBillingProfile (new)
Description :  Lists the role assignments for the caller on an billing profile while fetching user info for each role assignment. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/resolveBillingRoleAssignments
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
resolveScopeDisplayNames:
{
Description: Resolves the scope display name for each of the role assignments. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_DeleteByBillingAccount (new)
Description :  Deletes a role assignment on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_CreateOrUpdateByBillingAccount (new)
Description :  Create or update a billing role assignment. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments/{billingRoleAssignmentName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of the billing role assignment. ,
Required: True ,
}
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location: string ,
retry-after: integer ,
}
,
$schema:
{
Description: The properties of the billing role assignment. ,
}
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_CreateByBillingAccount (new)
Description :  Adds a role assignment on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/createBillingRoleAssignment
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of the billing role assignment. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_DeleteByDepartment (new)
Description :  Deletes a role assignment on a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_CreateOrUpdateByDepartment (new)
Description :  Create or update a billing role assignment. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleAssignments/{billingRoleAssignmentName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
departmentName:
{
Description: The name of the department. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of the billing role assignment. ,
Required: True ,
}
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location: string ,
retry-after: integer ,
}
,
$schema:
{
Description: The properties of the billing role assignment. ,
}
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_ListByDepartment (new)
Description :  Lists the role assignments for the caller on a department. The operation is supported for billing accounts of type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_DeleteByEnrollmentAccount (new)
Description :  Deletes a role assignment on a enrollment Account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_CreateOrUpdateByEnrollmentAccount (new)
Description :  Create or update a billing role assignment. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingRoleAssignments/{billingRoleAssignmentName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
enrollmentAccountName:
{
Description: The name of the enrollment account. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of the billing role assignment. ,
Required: True ,
}
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location: string ,
retry-after: integer ,
}
,
$schema:
{
Description: The properties of the billing role assignment. ,
}
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_ListByEnrollmentAccount (new)
Description :  Lists the role assignments for the caller on a enrollment account. The operation is supported for billing accounts of type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_ResolveByBillingAccount (new)
Description :  Lists the role assignments for the caller on a billing account while fetching user info for each role assignment. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/resolveBillingRoleAssignments
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
resolveScopeDisplayNames:
{
Description: Resolves the scope display name for each of the role assignments. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleDefinition_GetByBillingProfile (new)
Description :  Gets the definition for a role on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleDefinition_ListByBillingProfile (new)
Description :  Lists the role definitions for a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleDefinition_GetByCustomer (new)
Description :  Gets the definition for a role on a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleDefinition_ListByCustomer (new)
Description :  Lists the role definitions for a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleDefinition_GetByInvoiceSection (new)
Description :  Gets the definition for a role on an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleDefinition_ListByInvoiceSection (new)
Description :  Lists the role definitions for an invoice section. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleDefinition_GetByBillingAccount (new)
Description :  Gets the definition for a role on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleDefinition_ListByBillingAccount (new)
Description :  Lists the role definitions for a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleDefinition_GetByDepartment (new)
Description :  Gets the definition for a role on a department. The operation is supported for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleDefinition_ListByDepartment (new)
Description :  List the definition for a department. The operation is supported for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleDefinition_GetByEnrollmentAccount (new)
Description :  Gets the definition for a role on an enrollment account. The operation is supported for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleDefinition_ListByEnrollmentAccount (new)
Description :  List the definition for an enrollment account. The operation is supported for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SavingsPlanOrders_GetByBillingAccount (new)
Description :  Get a savings plan order by billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
savingsPlanOrderId:
{
Description: Order ID of the savings plan ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
expand:
{
Description: May be used to expand the planInformation. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: Savings plan SKU ,
Required: True ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Savings plan order properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the savings plan, e.g. Succeeded ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing SavingsPlan ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Fully-qualified identifier of the billing profile where the savings plan is applied. Present only for Field-led or Customer-led customers. ,
Required: False ,
}
string ,
customerId:
{
Description: Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: Fully-qualified identifier of the billing account where the savings plan is applied. ,
Required: False ,
}
string ,
term:
{
Description: Represents the Savings plan term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly purchases. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
benefitStartTime:
{
Description: DateTime when the savings plan benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: DateTime when the savings plan will expire. ,
Format: date-time ,
Required: False ,
}
string ,
planInformation:
{
Description: Information describing the type of billing plan for this savings plan. ,
Required: False ,
}
{
pricingCurrencyTotal:
{
Description: Amount of money to be paid for the Order. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
startDate:
{
Description: Date when the billing plan has started. ,
Format: date ,
Required: False ,
}
string ,
nextPaymentDueDate:
{
Description: For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off. ,
Format: date ,
Required: False ,
}
string ,
transactions:
{
Required: False ,
}
[
{
dueDate:
{
Description: Date when the payment needs to be done. ,
Format: date ,
Required: False ,
}
string ,
paymentDate:
{
Description: Date when the transaction is completed. Null when it is scheduled. ,
Format: date ,
Required: False ,
}
string ,
pricingCurrencyTotal:
{
Description: Amount in pricing currency. Tax not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Amount charged in Billing currency. Tax not included. Is null for future payments ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
status:
{
Description: Describes whether the payment is completed, failed, pending, cancelled or scheduled in the future. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Scheduled: No description available. ,
Cancelled: No description available. ,
Completed: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
extendedStatusInfo:
{
Description: Extended status information ,
Required: False ,
}
{
statusCode:
{
Description: Status code providing additional information. ,
Required: False ,
}
string ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to credit line check failure ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription that has failed credit line check. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
savingsPlans:
{
Required: False ,
}
[
string ,
]
,
extendedStatusInfo:
{
Description: Extended status information ,
Required: False ,
}
{
statusCode:
{
Description: Status code providing additional information. ,
Required: False ,
}
string ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to credit line check failure ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription that has failed credit line check. ,
Required: False ,
}
string ,
}
,
}
,
productCode:
{
Description: Represents UPN ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SavingsPlanOrders_ListByBillingAccount (new)
Description :  List all Savings plan orders by billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
skiptoken:
{
Description: The number of savings plans to skip from the list before returning results ,
Required: False ,
}
number ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
sku:
{
Description: Savings plan SKU ,
Required: True ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Savings plan order properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the savings plan, e.g. Succeeded ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing SavingsPlan ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Fully-qualified identifier of the billing profile where the savings plan is applied. Present only for Field-led or Customer-led customers. ,
Required: False ,
}
string ,
customerId:
{
Description: Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: Fully-qualified identifier of the billing account where the savings plan is applied. ,
Required: False ,
}
string ,
term:
{
Description: Represents the Savings plan term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly purchases. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
benefitStartTime:
{
Description: DateTime when the savings plan benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: DateTime when the savings plan will expire. ,
Format: date-time ,
Required: False ,
}
string ,
planInformation:
{
Description: Information describing the type of billing plan for this savings plan. ,
Required: False ,
}
{
pricingCurrencyTotal:
{
Description: Amount of money to be paid for the Order. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
startDate:
{
Description: Date when the billing plan has started. ,
Format: date ,
Required: False ,
}
string ,
nextPaymentDueDate:
{
Description: For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off. ,
Format: date ,
Required: False ,
}
string ,
transactions:
{
Required: False ,
}
[
{
dueDate:
{
Description: Date when the payment needs to be done. ,
Format: date ,
Required: False ,
}
string ,
paymentDate:
{
Description: Date when the transaction is completed. Null when it is scheduled. ,
Format: date ,
Required: False ,
}
string ,
pricingCurrencyTotal:
{
Description: Amount in pricing currency. Tax not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Amount charged in Billing currency. Tax not included. Is null for future payments ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
status:
{
Description: Describes whether the payment is completed, failed, pending, cancelled or scheduled in the future. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Scheduled: No description available. ,
Cancelled: No description available. ,
Completed: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
extendedStatusInfo:
{
Description: Extended status information ,
Required: False ,
}
{
statusCode:
{
Description: Status code providing additional information. ,
Required: False ,
}
string ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to credit line check failure ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription that has failed credit line check. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
savingsPlans:
{
Required: False ,
}
[
string ,
]
,
extendedStatusInfo:
{
Description: Extended status information ,
Required: False ,
}
{
statusCode:
{
Description: Status code providing additional information. ,
Required: False ,
}
string ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to credit line check failure ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription that has failed credit line check. ,
Required: False ,
}
string ,
}
,
}
,
productCode:
{
Description: Represents UPN ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Url to get the next page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SavingsPlans_ListBySavingsPlanOrder (new)
Description :  List savings plans in an order by billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
savingsPlanOrderId:
{
Description: Order ID of the savings plan ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
sku:
{
Description: Savings plan SKU ,
Required: True ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Savings plan properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Creating: No description available. ,
Failed: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the savings plan for display, e.g. Succeeded ,
Required: False ,
}
string ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the savings plan for display, e.g. Shared ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing SavingsPlan ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Fully-qualified identifier of the billing profile where the savings plan is applied. Present only for Field-led or Customer-led customers. ,
Required: False ,
}
string ,
customerId:
{
Description: Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: Fully-qualified identifier of the billing account where the savings plan is applied. ,
Required: False ,
}
string ,
term:
{
Description: Represents the Savings plan term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
renewSource:
{
Description: SavingsPlan Id of the SavingsPlan from which this SavingsPlan is renewed. ,
Required: False ,
}
string ,
renewDestination:
{
Description: SavingsPlan Id of the SavingsPlan which is purchased because of renew. ,
Required: False ,
}
string ,
renewProperties:
{
Description: Properties specific to renew. ,
Required: False ,
}
{
purchaseProperties:
{
Description: Purchase request. ,
Required: False ,
}
{
sku:
{
Description: The SKU to be applied for this resource ,
Required: False ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Purchase request properties. ,
Required: False ,
}
{
displayName:
{
Description: Friendly name of the savings plan ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing SavingsPlan ,
Required: False ,
}
string ,
term:
{
Description: Represents the Savings plan term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly purchases. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: Commitment grain. ,
Enum:
{
Hourly: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit is applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription where the benefit is applied. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group where the benefit is applied. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly purchases. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit is applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription where the benefit is applied. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group where the benefit is applied. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: Commitment grain. ,
Enum:
{
Hourly: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
effectiveDateTime:
{
Description: DateTime of the savings plan starting when this version is effective from. ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the savings plan benefit starts. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the savings plan will expire. ,
Format: date-time ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: Date time when the savings plan was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
utilization:
{
Description: Savings plan utilization ,
Required: False ,
}
{
trend:
{
Description: The trend for a savings plan's utilization ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a savings plan's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
extendedStatusInfo:
{
Description: Extended status information ,
Required: False ,
}
{
statusCode:
{
Description: Status code providing additional information. ,
Required: False ,
}
string ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to credit line check failure ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription that has failed credit line check. ,
Required: False ,
}
string ,
}
,
}
,
productCode:
{
Description: Represents UPN ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Url to get the next page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SavingsPlans_ListByBillingAccount (new)
Description :  List savings plans by billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlans
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
skiptoken:
{
Description: The number of savings plans to skip from the list before returning results ,
Required: False ,
}
number ,
take:
{
Description: The number of savings plans to return ,
Required: False ,
}
number ,
selectedState:
{
Description: The selected provisioning state ,
Required: False ,
}
string ,
refreshSummary:
{
Description: To indicate whether to refresh the roll up counts of the savings plans group by provisioning states ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
summary:
{
Description: The roll out count summary of the savings plans ,
Required: False ,
}
{
succeededCount:
{
Description: The number of savings plans in Succeeded state ,
Required: False ,
}
number ,
failedCount:
{
Description: The number of savings plans in Failed state ,
Required: False ,
}
number ,
expiringCount:
{
Description: The number of savings plans in Expiring state ,
Required: False ,
}
number ,
expiredCount:
{
Description: The number of savings plans in Expired state ,
Required: False ,
}
number ,
pendingCount:
{
Description: The number of savings plans in Pending state ,
Required: False ,
}
number ,
cancelledCount:
{
Description: The number of savings plans in Cancelled state ,
Required: False ,
}
number ,
processingCount:
{
Description: The number of savings plans in Processing state ,
Required: False ,
}
number ,
noBenefitCount:
{
Description: The number of savings plans in No Benefit state ,
Required: False ,
}
number ,
warningCount:
{
Description: The number of savings plans in Warning state ,
Required: False ,
}
number ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SavingsPlans_GetByBillingAccount (new)
Description :  Get savings plan by billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
savingsPlanOrderId:
{
Description: Order ID of the savings plan ,
Required: True ,
}
string ,
savingsPlanId:
{
Description: ID of the savings plan ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
expand:
{
Description: May be used to expand the planInformation. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: Savings plan SKU ,
Required: True ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Savings plan properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Creating: No description available. ,
Failed: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the savings plan for display, e.g. Succeeded ,
Required: False ,
}
string ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the savings plan for display, e.g. Shared ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing SavingsPlan ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Fully-qualified identifier of the billing profile where the savings plan is applied. Present only for Field-led or Customer-led customers. ,
Required: False ,
}
string ,
customerId:
{
Description: Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: Fully-qualified identifier of the billing account where the savings plan is applied. ,
Required: False ,
}
string ,
term:
{
Description: Represents the Savings plan term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
renewSource:
{
Description: SavingsPlan Id of the SavingsPlan from which this SavingsPlan is renewed. ,
Required: False ,
}
string ,
renewDestination:
{
Description: SavingsPlan Id of the SavingsPlan which is purchased because of renew. ,
Required: False ,
}
string ,
renewProperties:
{
Description: Properties specific to renew. ,
Required: False ,
}
{
purchaseProperties:
{
Description: Purchase request. ,
Required: False ,
}
{
sku:
{
Description: The SKU to be applied for this resource ,
Required: False ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Purchase request properties. ,
Required: False ,
}
{
displayName:
{
Description: Friendly name of the savings plan ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing SavingsPlan ,
Required: False ,
}
string ,
term:
{
Description: Represents the Savings plan term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly purchases. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: Commitment grain. ,
Enum:
{
Hourly: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit is applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription where the benefit is applied. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group where the benefit is applied. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly purchases. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit is applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription where the benefit is applied. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group where the benefit is applied. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: Commitment grain. ,
Enum:
{
Hourly: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
effectiveDateTime:
{
Description: DateTime of the savings plan starting when this version is effective from. ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the savings plan benefit starts. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the savings plan will expire. ,
Format: date-time ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: Date time when the savings plan was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
utilization:
{
Description: Savings plan utilization ,
Required: False ,
}
{
trend:
{
Description: The trend for a savings plan's utilization ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a savings plan's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
extendedStatusInfo:
{
Description: Extended status information ,
Required: False ,
}
{
statusCode:
{
Description: Status code providing additional information. ,
Required: False ,
}
string ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to credit line check failure ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription that has failed credit line check. ,
Required: False ,
}
string ,
}
,
}
,
productCode:
{
Description: Represents UPN ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SavingsPlans_UpdateByBillingAccount (new)
Description :  Update savings plan by billing account.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
savingsPlanOrderId:
{
Description: Order ID of the savings plan ,
Required: True ,
}
string ,
savingsPlanId:
{
Description: ID of the savings plan ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
body:
{
Description: Request body for patching a savings plan order alias ,
Required: True ,
}
{
properties:
{
Description: Savings plan patch request ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit is applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription where the benefit is applied. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group where the benefit is applied. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
renewProperties:
{
Description: Properties specific to renew. ,
Required: False ,
}
{
purchaseProperties:
{
Description: Purchase request. ,
Required: False ,
}
{
sku:
{
Description: The SKU to be applied for this resource ,
Required: False ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Purchase request properties. ,
Required: False ,
}
{
displayName:
{
Description: Friendly name of the savings plan ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing SavingsPlan ,
Required: False ,
}
string ,
term:
{
Description: Represents the Savings plan term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly purchases. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: Commitment grain. ,
Enum:
{
Hourly: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit is applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription where the benefit is applied. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group where the benefit is applied. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}
,
sku:
{
Description: The SKU to be applied for this resource ,
Required: False ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Tags for this reservation ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
sku:
{
Description: Savings plan SKU ,
Required: True ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Savings plan properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Creating: No description available. ,
Failed: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the savings plan for display, e.g. Succeeded ,
Required: False ,
}
string ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the savings plan for display, e.g. Shared ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing SavingsPlan ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Fully-qualified identifier of the billing profile where the savings plan is applied. Present only for Field-led or Customer-led customers. ,
Required: False ,
}
string ,
customerId:
{
Description: Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: Fully-qualified identifier of the billing account where the savings plan is applied. ,
Required: False ,
}
string ,
term:
{
Description: Represents the Savings plan term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
renewSource:
{
Description: SavingsPlan Id of the SavingsPlan from which this SavingsPlan is renewed. ,
Required: False ,
}
string ,
renewDestination:
{
Description: SavingsPlan Id of the SavingsPlan which is purchased because of renew. ,
Required: False ,
}
string ,
renewProperties:
{
Description: Properties specific to renew. ,
Required: False ,
}
{
purchaseProperties:
{
Description: Purchase request. ,
Required: False ,
}
{
sku:
{
Description: The SKU to be applied for this resource ,
Required: False ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Purchase request properties. ,
Required: False ,
}
{
displayName:
{
Description: Friendly name of the savings plan ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing SavingsPlan ,
Required: False ,
}
string ,
term:
{
Description: Represents the Savings plan term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly purchases. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: Commitment grain. ,
Enum:
{
Hourly: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit is applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription where the benefit is applied. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group where the benefit is applied. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly purchases. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit is applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription where the benefit is applied. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group where the benefit is applied. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: Commitment grain. ,
Enum:
{
Hourly: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
effectiveDateTime:
{
Description: DateTime of the savings plan starting when this version is effective from. ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the savings plan benefit starts. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the savings plan will expire. ,
Format: date-time ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: Date time when the savings plan was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
utilization:
{
Description: Savings plan utilization ,
Required: False ,
}
{
trend:
{
Description: The trend for a savings plan's utilization ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a savings plan's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
extendedStatusInfo:
{
Description: Extended status information ,
Required: False ,
}
{
statusCode:
{
Description: Status code providing additional information. ,
Required: False ,
}
string ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to credit line check failure ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription that has failed credit line check. ,
Required: False ,
}
string ,
}
,
}
,
productCode:
{
Description: Represents UPN ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
location:
{
Description: URL for determining when an operation has completed. Only use this value only when Azure-AsyncOperation isn't returned. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SavingsPlans_ValidateUpdateByBillingAccount (new)
Description :  Validate savings plan patch by billing account.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/validate
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
savingsPlanOrderId:
{
Description: Order ID of the savings plan ,
Required: True ,
}
string ,
savingsPlanId:
{
Description: ID of the savings plan ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
body:
{
Description: Request body for patching a savings plan order alias ,
Required: True ,
}
{
benefits:
{
Description: The benefits of a savings plan. ,
Required: False ,
}
[
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit is applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription where the benefit is applied. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group where the benefit is applied. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
renewProperties:
{
Description: Properties specific to renew. ,
Required: False ,
}
{
purchaseProperties:
{
Description: Purchase request. ,
Required: False ,
}
{
sku:
{
Description: The SKU to be applied for this resource ,
Required: False ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Purchase request properties. ,
Required: False ,
}
{
displayName:
{
Description: Friendly name of the savings plan ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing SavingsPlan ,
Required: False ,
}
string ,
term:
{
Description: Represents the Savings plan term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly purchases. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: Commitment grain. ,
Enum:
{
Hourly: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit is applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription where the benefit is applied. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group where the benefit is applied. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}
,
]
,
}
,
}

⚐ Response (200)

{
benefits:
{
Required: False ,
}
[
{
valid:
{
Description: Indicates if the provided input is valid ,
Required: False ,
}
boolean ,
reasonCode:
{
Description: Failure reason code if the provided input is invalid ,
Required: False ,
}
string ,
reason:
{
Description: Failure reason if the provided input is invalid ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Url to get the next page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptions_GetByBillingProfile (new)
Description :  Gets a subscription by its billing profile and ID. The operation is supported for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingSubscriptions/{billingSubscriptionName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: The ID that uniquely identifies a subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
expand:
{
Description: Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges` ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a(n) BillingSubscription ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
beneficiary:
{
Description: The beneficiary of the billing subscription. ,
Required: False ,
}
{
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
objectId:
{
Description: The ID that uniquely identifies a user in a tenant. ,
Required: False ,
}
string ,
}
,
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
{
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. ,
Enum:
{
Active: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Deleted: No description available. ,
TransferredOut: No description available. ,
Transferring: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
lastMonthCharges:
{
Description: The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: Billing frequency of the product under the subscription. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
productCategory:
{
Description: The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. ,
Required: False ,
}
string ,
productType:
{
Description: Type of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: Purchase date of the product in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
renewalTermDetails:
{
Description: Details for the next renewal term of a subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
productId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Type Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. ,
Required: False ,
}
string ,
systemOverrides:
{
Description: System imposed policies that regulate behavior of the subscription. ,
Required: False ,
}
{
cancellation:
{
Description: The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed. ,
Enum:
{
NotAllowed: No description available. ,
Allowed: No description available. ,
}
,
Required: False ,
}
enum ,
cancellationAllowedEndDate:
{
Description: The end date in UTC time by when the self-serve cancellation ends. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resourceUri:
{
Description: Unique identifier of the linked resource. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
termStartDate:
{
Description: Start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningTenantId:
{
Description: The tenant in which the subscription is provisioned. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
operationStatus:
{
Description: The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
LockedForUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the subscription. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
suspensionReasonDetails:
{
Description: The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingSubscriptions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
includeDeleted:
{
Description: Can be used to get deleted billing subscriptions. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
expand:
{
Description: Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges` ,
Required: False ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a(n) BillingSubscription ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
beneficiary:
{
Description: The beneficiary of the billing subscription. ,
Required: False ,
}
{
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
objectId:
{
Description: The ID that uniquely identifies a user in a tenant. ,
Required: False ,
}
string ,
}
,
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
{
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. ,
Enum:
{
Active: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Deleted: No description available. ,
TransferredOut: No description available. ,
Transferring: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
lastMonthCharges:
{
Description: The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: Billing frequency of the product under the subscription. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
productCategory:
{
Description: The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. ,
Required: False ,
}
string ,
productType:
{
Description: Type of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: Purchase date of the product in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
renewalTermDetails:
{
Description: Details for the next renewal term of a subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
productId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Type Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. ,
Required: False ,
}
string ,
systemOverrides:
{
Description: System imposed policies that regulate behavior of the subscription. ,
Required: False ,
}
{
cancellation:
{
Description: The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed. ,
Enum:
{
NotAllowed: No description available. ,
Allowed: No description available. ,
}
,
Required: False ,
}
enum ,
cancellationAllowedEndDate:
{
Description: The end date in UTC time by when the self-serve cancellation ends. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resourceUri:
{
Description: Unique identifier of the linked resource. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
termStartDate:
{
Description: Start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningTenantId:
{
Description: The tenant in which the subscription is provisioned. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
operationStatus:
{
Description: The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
LockedForUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the subscription. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
suspensionReasonDetails:
{
Description: The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptions_ListByCustomer (new)
Description :  Lists the subscriptions for a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/billingSubscriptions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
includeDeleted:
{
Description: Can be used to get deleted billing subscriptions. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
expand:
{
Description: Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges` ,
Required: False ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a(n) BillingSubscription ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
beneficiary:
{
Description: The beneficiary of the billing subscription. ,
Required: False ,
}
{
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
objectId:
{
Description: The ID that uniquely identifies a user in a tenant. ,
Required: False ,
}
string ,
}
,
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
{
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. ,
Enum:
{
Active: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Deleted: No description available. ,
TransferredOut: No description available. ,
Transferring: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
lastMonthCharges:
{
Description: The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: Billing frequency of the product under the subscription. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
productCategory:
{
Description: The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. ,
Required: False ,
}
string ,
productType:
{
Description: Type of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: Purchase date of the product in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
renewalTermDetails:
{
Description: Details for the next renewal term of a subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
productId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Type Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. ,
Required: False ,
}
string ,
systemOverrides:
{
Description: System imposed policies that regulate behavior of the subscription. ,
Required: False ,
}
{
cancellation:
{
Description: The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed. ,
Enum:
{
NotAllowed: No description available. ,
Allowed: No description available. ,
}
,
Required: False ,
}
enum ,
cancellationAllowedEndDate:
{
Description: The end date in UTC time by when the self-serve cancellation ends. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resourceUri:
{
Description: Unique identifier of the linked resource. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
termStartDate:
{
Description: Start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningTenantId:
{
Description: The tenant in which the subscription is provisioned. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
operationStatus:
{
Description: The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
LockedForUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the subscription. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
suspensionReasonDetails:
{
Description: The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingSubscriptions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
includeDeleted:
{
Description: Can be used to get deleted billing subscriptions. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
expand:
{
Description: Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges` ,
Required: False ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a(n) BillingSubscription ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
beneficiary:
{
Description: The beneficiary of the billing subscription. ,
Required: False ,
}
{
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
objectId:
{
Description: The ID that uniquely identifies a user in a tenant. ,
Required: False ,
}
string ,
}
,
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
{
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. ,
Enum:
{
Active: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Deleted: No description available. ,
TransferredOut: No description available. ,
Transferring: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
lastMonthCharges:
{
Description: The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: Billing frequency of the product under the subscription. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
productCategory:
{
Description: The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. ,
Required: False ,
}
string ,
productType:
{
Description: Type of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: Purchase date of the product in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
renewalTermDetails:
{
Description: Details for the next renewal term of a subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
productId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Type Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. ,
Required: False ,
}
string ,
systemOverrides:
{
Description: System imposed policies that regulate behavior of the subscription. ,
Required: False ,
}
{
cancellation:
{
Description: The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed. ,
Enum:
{
NotAllowed: No description available. ,
Allowed: No description available. ,
}
,
Required: False ,
}
enum ,
cancellationAllowedEndDate:
{
Description: The end date in UTC time by when the self-serve cancellation ends. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resourceUri:
{
Description: Unique identifier of the linked resource. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
termStartDate:
{
Description: Start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningTenantId:
{
Description: The tenant in which the subscription is provisioned. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
operationStatus:
{
Description: The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
LockedForUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the subscription. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
suspensionReasonDetails:
{
Description: The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptionsAliases_Get (new)
Description :  Gets a subscription by its alias ID. The operation is supported for seat based billing subscriptions.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptionAliases/{aliasName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
aliasName:
{
Description: The ID that uniquely identifies a subscription alias. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a(n) BillingSubscriptionAlias ,
Required: False ,
}
{
billingSubscriptionId:
{
Description: The ID of the billing subscription with the subscription alias. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptionsAliases_CreateOrUpdate (new)
Description :  Creates or updates a billing subscription by its alias ID. The operation is supported for seat based billing subscriptions.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptionAliases/{aliasName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
aliasName:
{
Description: The ID that uniquely identifies a subscription alias. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: A billing subscription alias. ,
Required: True ,
}
{
properties:
{
Description: The properties of a(n) BillingSubscriptionAlias ,
Required: False ,
}
{
billingSubscriptionId:
{
Description: The ID of the billing subscription with the subscription alias. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a(n) BillingSubscriptionAlias ,
Required: False ,
}
{
billingSubscriptionId:
{
Description: The ID of the billing subscription with the subscription alias. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a(n) BillingSubscriptionAlias ,
Required: False ,
}
{
billingSubscriptionId:
{
Description: The ID of the billing subscription with the subscription alias. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptionsAliases_ListByBillingAccount (new)
Description :  Lists the subscription aliases for a billing account. The operation is supported for seat based billing subscriptions.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptionAliases
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
includeDeleted:
{
Description: Can be used to get deleted billing subscriptions. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a(n) BillingSubscriptionAlias ,
Required: False ,
}
{
billingSubscriptionId:
{
Description: The ID of the billing subscription with the subscription alias. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptions_Cancel (new)
Description :  Cancels a usage-based subscription. This operation is supported only for billing accounts of type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}/cancel
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: The ID that uniquely identifies a subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters for cancel customer subscription. ,
Required: True ,
}
{
cancellationReason:
{
Description: Cancellation reason. ,
Enum:
{
Other: No description available. ,
Compromise: No description available. ,
Dispute: No description available. ,
}
,
Required: True ,
}
enum ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptions_Merge (new)
Description :  Merges the billing subscription provided in the request with a target billing subscription.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}/merge
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: The ID that uniquely identifies a subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to merge the two billing subscriptions. ,
Required: True ,
}
{
targetBillingSubscriptionName:
{
Description: The ID of the target billing subscription that will be merged with the source subscription provided in the request. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of the source billing subscription that will be merged with the target billing subscription. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a(n) BillingSubscription ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
beneficiary:
{
Description: The beneficiary of the billing subscription. ,
Required: False ,
}
{
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
objectId:
{
Description: The ID that uniquely identifies a user in a tenant. ,
Required: False ,
}
string ,
}
,
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
{
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. ,
Enum:
{
Active: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Deleted: No description available. ,
TransferredOut: No description available. ,
Transferring: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
lastMonthCharges:
{
Description: The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: Billing frequency of the product under the subscription. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
productCategory:
{
Description: The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. ,
Required: False ,
}
string ,
productType:
{
Description: Type of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: Purchase date of the product in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
renewalTermDetails:
{
Description: Details for the next renewal term of a subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
productId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Type Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. ,
Required: False ,
}
string ,
systemOverrides:
{
Description: System imposed policies that regulate behavior of the subscription. ,
Required: False ,
}
{
cancellation:
{
Description: The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed. ,
Enum:
{
NotAllowed: No description available. ,
Allowed: No description available. ,
}
,
Required: False ,
}
enum ,
cancellationAllowedEndDate:
{
Description: The end date in UTC time by when the self-serve cancellation ends. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resourceUri:
{
Description: Unique identifier of the linked resource. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
termStartDate:
{
Description: Start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningTenantId:
{
Description: The tenant in which the subscription is provisioned. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
operationStatus:
{
Description: The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
LockedForUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the subscription. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
suspensionReasonDetails:
{
Description: The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptions_Move (new)
Description :  Moves charges for a subscription to a new invoice section. The new invoice section must belong to the same billing profile as the existing invoice section. This operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}/move
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: The ID that uniquely identifies a subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters to transfer billing subscription. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: False ,
}
string ,
destinationEnrollmentAccountId:
{
Description: The destination enrollment account id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a(n) BillingSubscription ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
beneficiary:
{
Description: The beneficiary of the billing subscription. ,
Required: False ,
}
{
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
objectId:
{
Description: The ID that uniquely identifies a user in a tenant. ,
Required: False ,
}
string ,
}
,
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
{
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. ,
Enum:
{
Active: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Deleted: No description available. ,
TransferredOut: No description available. ,
Transferring: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
lastMonthCharges:
{
Description: The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: Billing frequency of the product under the subscription. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
productCategory:
{
Description: The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. ,
Required: False ,
}
string ,
productType:
{
Description: Type of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: Purchase date of the product in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
renewalTermDetails:
{
Description: Details for the next renewal term of a subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
productId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Type Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. ,
Required: False ,
}
string ,
systemOverrides:
{
Description: System imposed policies that regulate behavior of the subscription. ,
Required: False ,
}
{
cancellation:
{
Description: The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed. ,
Enum:
{
NotAllowed: No description available. ,
Allowed: No description available. ,
}
,
Required: False ,
}
enum ,
cancellationAllowedEndDate:
{
Description: The end date in UTC time by when the self-serve cancellation ends. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resourceUri:
{
Description: Unique identifier of the linked resource. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
termStartDate:
{
Description: Start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningTenantId:
{
Description: The tenant in which the subscription is provisioned. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
operationStatus:
{
Description: The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
LockedForUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the subscription. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
suspensionReasonDetails:
{
Description: The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptions_Split (new)
Description :  Splits a subscription into a new subscription with quantity less than current subscription quantity and not equal to 0.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}/split
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: The ID that uniquely identifies a subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to split the billing subscription. ,
Required: True ,
}
{
targetProductTypeId:
{
Description: The ID of the target product to which the subscription needs to be split into. This value is not same as the value returned in Get API call and can be retrieved from Catalog API to know the product id to split into. ,
Required: False ,
}
string ,
targetSkuId:
{
Description: The ID of the target product to which the subscription needs to be split into. This value is not same as the value returned in Get API call and can be retrieved from Catalog API to know the sku id to split into. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of the target product to which the subscription needs to be split into. ,
Format: int32 ,
Required: False ,
}
integer ,
termDuration:
{
Description: The term duration of the target in ISO8601 format product to which the subscription needs to be split into. Example: P1M, P1Y ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The billing frequency of the target subscription in the ISO8601 format. Example: P1M, P3M, P1Y" ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a(n) BillingSubscription ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
beneficiary:
{
Description: The beneficiary of the billing subscription. ,
Required: False ,
}
{
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
objectId:
{
Description: The ID that uniquely identifies a user in a tenant. ,
Required: False ,
}
string ,
}
,
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
{
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. ,
Enum:
{
Active: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Deleted: No description available. ,
TransferredOut: No description available. ,
Transferring: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
lastMonthCharges:
{
Description: The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: Billing frequency of the product under the subscription. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
productCategory:
{
Description: The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. ,
Required: False ,
}
string ,
productType:
{
Description: Type of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: Purchase date of the product in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
renewalTermDetails:
{
Description: Details for the next renewal term of a subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
productId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Type Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. ,
Required: False ,
}
string ,
systemOverrides:
{
Description: System imposed policies that regulate behavior of the subscription. ,
Required: False ,
}
{
cancellation:
{
Description: The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed. ,
Enum:
{
NotAllowed: No description available. ,
Allowed: No description available. ,
}
,
Required: False ,
}
enum ,
cancellationAllowedEndDate:
{
Description: The end date in UTC time by when the self-serve cancellation ends. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resourceUri:
{
Description: Unique identifier of the linked resource. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
termStartDate:
{
Description: Start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningTenantId:
{
Description: The tenant in which the subscription is provisioned. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
operationStatus:
{
Description: The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
LockedForUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the subscription. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
suspensionReasonDetails:
{
Description: The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptions_ValidateMoveEligibility (new)
Description :  Validates if charges for a subscription can be moved to a new invoice section. This operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}/validateMoveEligibility
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: The ID that uniquely identifies a subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters to transfer billing subscription. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: False ,
}
string ,
destinationEnrollmentAccountId:
{
Description: The destination enrollment account id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
isMoveEligible:
{
Description: Specifies whether the subscription is eligible to be transferred. ,
Required: False ,
}
boolean ,
errorDetails:
{
Description: Error details of the transfer eligibility validation. ,
Required: False ,
}
{
code:
{
Description: Error code of the transfer validation response. ,
Enum:
{
Other: No description available. ,
BillingAccountInactive: No description available. ,
DestinationBillingProfileInactive: No description available. ,
DestinationBillingProfileNotFound: No description available. ,
DestinationBillingProfilePastDue: No description available. ,
DestinationInvoiceSectionInactive: No description available. ,
DestinationInvoiceSectionNotFound: No description available. ,
InsufficientPermissionOnDestination: No description available. ,
InsufficientPermissionOnSource: No description available. ,
InvalidDestination: No description available. ,
InvalidSource: No description available. ,
MarketplaceNotEnabledOnDestination: No description available. ,
ProductInactive: No description available. ,
ProductNotFound: No description available. ,
ProductTypeNotSupported: No description available. ,
SourceBillingProfilePastDue: No description available. ,
SourceInvoiceSectionInactive: No description available. ,
AccountIsLocked: No description available. ,
AssetHasCap: No description available. ,
AssetNotActive: No description available. ,
BillingProfilePastDue: No description available. ,
CrossBillingAccountNotAllowed: No description available. ,
NoActiveAzurePlan: No description available. ,
None: No description available. ,
SubscriptionNotActive: No description available. ,
SubscriptionHasReservations: No description available. ,
SubscriptionTypeNotSupported: No description available. ,
InvoiceSectionIsRestricted: 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 error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptions_Delete (new)
Description :  Cancels a billing subscription. This operation is supported only for billing accounts of type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptions_Get (new)
Description :  Gets a subscription by its ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement, Microsoft Partner Agreement, and Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: The ID that uniquely identifies a subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
expand:
{
Description: Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges` ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a(n) BillingSubscription ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
beneficiary:
{
Description: The beneficiary of the billing subscription. ,
Required: False ,
}
{
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
objectId:
{
Description: The ID that uniquely identifies a user in a tenant. ,
Required: False ,
}
string ,
}
,
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
{
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. ,
Enum:
{
Active: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Deleted: No description available. ,
TransferredOut: No description available. ,
Transferring: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
lastMonthCharges:
{
Description: The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: Billing frequency of the product under the subscription. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
productCategory:
{
Description: The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. ,
Required: False ,
}
string ,
productType:
{
Description: Type of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: Purchase date of the product in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
renewalTermDetails:
{
Description: Details for the next renewal term of a subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
productId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Type Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. ,
Required: False ,
}
string ,
systemOverrides:
{
Description: System imposed policies that regulate behavior of the subscription. ,
Required: False ,
}
{
cancellation:
{
Description: The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed. ,
Enum:
{
NotAllowed: No description available. ,
Allowed: No description available. ,
}
,
Required: False ,
}
enum ,
cancellationAllowedEndDate:
{
Description: The end date in UTC time by when the self-serve cancellation ends. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resourceUri:
{
Description: Unique identifier of the linked resource. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
termStartDate:
{
Description: Start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningTenantId:
{
Description: The tenant in which the subscription is provisioned. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
operationStatus:
{
Description: The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
LockedForUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the subscription. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
suspensionReasonDetails:
{
Description: The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptions_Update (new)
Description :  Updates the properties of a billing subscription.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: The ID that uniquely identifies a subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The billing properties of a subscription. ,
Required: True ,
}
{
properties:
{
Description: The properties of a(n) BillingSubscription ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
beneficiary:
{
Description: The beneficiary of the billing subscription. ,
Required: False ,
}
{
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
objectId:
{
Description: The ID that uniquely identifies a user in a tenant. ,
Required: False ,
}
string ,
}
,
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
{
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. ,
Enum:
{
Active: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Deleted: No description available. ,
TransferredOut: No description available. ,
Transferring: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
lastMonthCharges:
{
Description: The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: Billing frequency of the product under the subscription. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
productCategory:
{
Description: The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. ,
Required: False ,
}
string ,
productType:
{
Description: Type of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: Purchase date of the product in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
renewalTermDetails:
{
Description: Details for the next renewal term of a subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
productId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Type Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. ,
Required: False ,
}
string ,
systemOverrides:
{
Description: System imposed policies that regulate behavior of the subscription. ,
Required: False ,
}
{
cancellation:
{
Description: The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed. ,
Enum:
{
NotAllowed: No description available. ,
Allowed: No description available. ,
}
,
Required: False ,
}
enum ,
cancellationAllowedEndDate:
{
Description: The end date in UTC time by when the self-serve cancellation ends. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resourceUri:
{
Description: Unique identifier of the linked resource. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
termStartDate:
{
Description: Start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningTenantId:
{
Description: The tenant in which the subscription is provisioned. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
operationStatus:
{
Description: The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
LockedForUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the subscription. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
suspensionReasonDetails:
{
Description: The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a(n) BillingSubscription ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
beneficiary:
{
Description: The beneficiary of the billing subscription. ,
Required: False ,
}
{
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
objectId:
{
Description: The ID that uniquely identifies a user in a tenant. ,
Required: False ,
}
string ,
}
,
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
{
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. ,
Enum:
{
Active: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Deleted: No description available. ,
TransferredOut: No description available. ,
Transferring: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
lastMonthCharges:
{
Description: The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: Billing frequency of the product under the subscription. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
productCategory:
{
Description: The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. ,
Required: False ,
}
string ,
productType:
{
Description: Type of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: Purchase date of the product in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
renewalTermDetails:
{
Description: Details for the next renewal term of a subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
productId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Type Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. ,
Required: False ,
}
string ,
systemOverrides:
{
Description: System imposed policies that regulate behavior of the subscription. ,
Required: False ,
}
{
cancellation:
{
Description: The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed. ,
Enum:
{
NotAllowed: No description available. ,
Allowed: No description available. ,
}
,
Required: False ,
}
enum ,
cancellationAllowedEndDate:
{
Description: The end date in UTC time by when the self-serve cancellation ends. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resourceUri:
{
Description: Unique identifier of the linked resource. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
termStartDate:
{
Description: Start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningTenantId:
{
Description: The tenant in which the subscription is provisioned. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
operationStatus:
{
Description: The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
LockedForUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the subscription. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
suspensionReasonDetails:
{
Description: The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptions_ListByBillingAccount (new)
Description :  Lists the subscriptions for a billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
includeDeleted:
{
Description: Can be used to get deleted billing subscriptions. ,
Required: False ,
}
boolean ,
includeTenantSubscriptions:
{
Description: Can be used to get tenant-owned billing subscriptions. This field is only applies to Microsoft Online Services Program billing accounts. ,
Required: False ,
}
boolean ,
includeFailed:
{
Description: Can be used to get failed billing subscriptions. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
expand:
{
Description: Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges` ,
Required: False ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a(n) BillingSubscription ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
beneficiary:
{
Description: The beneficiary of the billing subscription. ,
Required: False ,
}
{
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
objectId:
{
Description: The ID that uniquely identifies a user in a tenant. ,
Required: False ,
}
string ,
}
,
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
{
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. ,
Enum:
{
Active: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Deleted: No description available. ,
TransferredOut: No description available. ,
Transferring: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
lastMonthCharges:
{
Description: The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: Billing frequency of the product under the subscription. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
productCategory:
{
Description: The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. ,
Required: False ,
}
string ,
productType:
{
Description: Type of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: Purchase date of the product in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
renewalTermDetails:
{
Description: Details for the next renewal term of a subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
productId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Type Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. ,
Required: False ,
}
string ,
systemOverrides:
{
Description: System imposed policies that regulate behavior of the subscription. ,
Required: False ,
}
{
cancellation:
{
Description: The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed. ,
Enum:
{
NotAllowed: No description available. ,
Allowed: No description available. ,
}
,
Required: False ,
}
enum ,
cancellationAllowedEndDate:
{
Description: The end date in UTC time by when the self-serve cancellation ends. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resourceUri:
{
Description: Unique identifier of the linked resource. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
termStartDate:
{
Description: Start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningTenantId:
{
Description: The tenant in which the subscription is provisioned. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
operationStatus:
{
Description: The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
LockedForUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the subscription. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
suspensionReasonDetails:
{
Description: The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptions_ListByCustomerAtBillingAccount (new)
Description :  Lists the subscriptions for a customer at billing account level. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/billingSubscriptions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
includeDeleted:
{
Description: Can be used to get deleted billing subscriptions. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
expand:
{
Description: Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges` ,
Required: False ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a(n) BillingSubscription ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
beneficiary:
{
Description: The beneficiary of the billing subscription. ,
Required: False ,
}
{
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
objectId:
{
Description: The ID that uniquely identifies a user in a tenant. ,
Required: False ,
}
string ,
}
,
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
{
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. ,
Enum:
{
Active: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Deleted: No description available. ,
TransferredOut: No description available. ,
Transferring: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
lastMonthCharges:
{
Description: The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: Billing frequency of the product under the subscription. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
productCategory:
{
Description: The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. ,
Required: False ,
}
string ,
productType:
{
Description: Type of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: Purchase date of the product in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
renewalTermDetails:
{
Description: Details for the next renewal term of a subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
productId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Type Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. ,
Required: False ,
}
string ,
systemOverrides:
{
Description: System imposed policies that regulate behavior of the subscription. ,
Required: False ,
}
{
cancellation:
{
Description: The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed. ,
Enum:
{
NotAllowed: No description available. ,
Allowed: No description available. ,
}
,
Required: False ,
}
enum ,
cancellationAllowedEndDate:
{
Description: The end date in UTC time by when the self-serve cancellation ends. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resourceUri:
{
Description: Unique identifier of the linked resource. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
termStartDate:
{
Description: Start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningTenantId:
{
Description: The tenant in which the subscription is provisioned. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
operationStatus:
{
Description: The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
LockedForUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the subscription. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
suspensionReasonDetails:
{
Description: The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptions_ListByEnrollmentAccount (new)
Description :  Lists the subscriptions for an enrollment account. The operation is supported for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingSubscriptions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
enrollmentAccountName:
{
Description: The name of the enrollment account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a(n) BillingSubscription ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
beneficiary:
{
Description: The beneficiary of the billing subscription. ,
Required: False ,
}
{
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
objectId:
{
Description: The ID that uniquely identifies a user in a tenant. ,
Required: False ,
}
string ,
}
,
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
{
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. ,
Enum:
{
Active: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Deleted: No description available. ,
TransferredOut: No description available. ,
Transferring: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
lastMonthCharges:
{
Description: The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: Billing frequency of the product under the subscription. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
productCategory:
{
Description: The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. ,
Required: False ,
}
string ,
productType:
{
Description: Type of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: Purchase date of the product in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
renewalTermDetails:
{
Description: Details for the next renewal term of a subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
productId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Type Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. ,
Required: False ,
}
string ,
systemOverrides:
{
Description: System imposed policies that regulate behavior of the subscription. ,
Required: False ,
}
{
cancellation:
{
Description: The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed. ,
Enum:
{
NotAllowed: No description available. ,
Allowed: No description available. ,
}
,
Required: False ,
}
enum ,
cancellationAllowedEndDate:
{
Description: The end date in UTC time by when the self-serve cancellation ends. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resourceUri:
{
Description: Unique identifier of the linked resource. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
termStartDate:
{
Description: Start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningTenantId:
{
Description: The tenant in which the subscription is provisioned. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
operationStatus:
{
Description: The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
LockedForUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the subscription. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
suspensionReasonDetails:
{
Description: The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Customers_Get (new)
Description :  Gets a customer by its ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: A partner's customer. ,
Required: False ,
}
{
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
systemId:
{
Description: The system generated unique identifier for a customer. ,
Required: False ,
}
string ,
status:
{
Description: Identifies the status of an customer. This is an upcoming property that will be populated in the future. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
enabledAzurePlans:
{
Description: Azure plans enabled for the customer. ,
Required: False ,
}
[
{
productId:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
skuId:
{
Description: The ID that uniquely identifies a sku. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
resellers:
{
Description: The list of resellers for which an Azure plan is enabled for the customer. ,
Required: False ,
}
[
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
]
,
tags:
{
Description: Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
expand:
{
Description: May be used to expand enabledAzurePlans and resellers ,
Required: False ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A partner's customer. ,
Required: False ,
}
{
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
systemId:
{
Description: The system generated unique identifier for a customer. ,
Required: False ,
}
string ,
status:
{
Description: Identifies the status of an customer. This is an upcoming property that will be populated in the future. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
enabledAzurePlans:
{
Description: Azure plans enabled for the customer. ,
Required: False ,
}
[
{
productId:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
skuId:
{
Description: The ID that uniquely identifies a sku. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
resellers:
{
Description: The list of resellers for which an Azure plan is enabled for the customer. ,
Required: False ,
}
[
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
]
,
tags:
{
Description: Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Customers_GetByBillingAccount (new)
Description :  Gets a customer by its ID at billing account level. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: A partner's customer. ,
Required: False ,
}
{
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
systemId:
{
Description: The system generated unique identifier for a customer. ,
Required: False ,
}
string ,
status:
{
Description: Identifies the status of an customer. This is an upcoming property that will be populated in the future. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
enabledAzurePlans:
{
Description: Azure plans enabled for the customer. ,
Required: False ,
}
[
{
productId:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
skuId:
{
Description: The ID that uniquely identifies a sku. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
resellers:
{
Description: The list of resellers for which an Azure plan is enabled for the customer. ,
Required: False ,
}
[
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
]
,
tags:
{
Description: Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
expand:
{
Description: May be used to expand enabledAzurePlans and resellers ,
Required: False ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A partner's customer. ,
Required: False ,
}
{
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
systemId:
{
Description: The system generated unique identifier for a customer. ,
Required: False ,
}
string ,
status:
{
Description: Identifies the status of an customer. This is an upcoming property that will be populated in the future. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
enabledAzurePlans:
{
Description: Azure plans enabled for the customer. ,
Required: False ,
}
[
{
productId:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
skuId:
{
Description: The ID that uniquely identifies a sku. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
resellers:
{
Description: The list of resellers for which an Azure plan is enabled for the customer. ,
Required: False ,
}
[
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
]
,
tags:
{
Description: Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Departments_Get (new)
Description :  Gets a department by ID. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Optional grouping of enrollment accounts to segment costs into logical groupings and set budgets. ,
Required: False ,
}
{
costCenter:
{
Description: The cost center associated with the department. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the department. ,
Required: False ,
}
string ,
id:
{
Description: The ID that uniquely identifies the department. ,
Required: False ,
}
string ,
status:
{
Description: The status of the department. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Departments_ListByBillingAccount (new)
Description :  Lists the departments that a user has access to. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: Optional grouping of enrollment accounts to segment costs into logical groupings and set budgets. ,
Required: False ,
}
{
costCenter:
{
Description: The cost center associated with the department. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the department. ,
Required: False ,
}
string ,
id:
{
Description: The ID that uniquely identifies the department. ,
Required: False ,
}
string ,
status:
{
Description: The status of the department. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EnrollmentAccounts_GetByDepartment (new)
Description :  Gets an enrollment account by department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: It is an organizational hierarchy within a billing account to administer and manage azure costs. ,
Required: False ,
}
{
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
departmentDisplayName:
{
Description: The name of the department under which the enrollment account exists. ,
Required: False ,
}
string ,
departmentId:
{
Description: The ID that uniquely identifies the department. ,
Required: False ,
}
string ,
isDevTestEnabled:
{
Description: Boolean flag which enables subscribers to run development and testing workloads on Azure at special Dev/Test rates. ,
Required: False ,
}
boolean ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
authType:
{
Description: The authorization type of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The date from which the enrollment account became valid and functional. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date of expiration of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EnrollmentAccounts_ListByDepartment (new)
Description :  Lists the enrollment accounts for a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/enrollmentAccounts
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
departmentName:
{
Description: The name of the department. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: It is an organizational hierarchy within a billing account to administer and manage azure costs. ,
Required: False ,
}
{
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
departmentDisplayName:
{
Description: The name of the department under which the enrollment account exists. ,
Required: False ,
}
string ,
departmentId:
{
Description: The ID that uniquely identifies the department. ,
Required: False ,
}
string ,
isDevTestEnabled:
{
Description: Boolean flag which enables subscribers to run development and testing workloads on Azure at special Dev/Test rates. ,
Required: False ,
}
boolean ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
authType:
{
Description: The authorization type of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The date from which the enrollment account became valid and functional. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date of expiration of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EnrollmentAccounts_Get (new)
Description :  Gets an enrollment account by ID. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: It is an organizational hierarchy within a billing account to administer and manage azure costs. ,
Required: False ,
}
{
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
departmentDisplayName:
{
Description: The name of the department under which the enrollment account exists. ,
Required: False ,
}
string ,
departmentId:
{
Description: The ID that uniquely identifies the department. ,
Required: False ,
}
string ,
isDevTestEnabled:
{
Description: Boolean flag which enables subscribers to run development and testing workloads on Azure at special Dev/Test rates. ,
Required: False ,
}
boolean ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
authType:
{
Description: The authorization type of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The date from which the enrollment account became valid and functional. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date of expiration of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EnrollmentAccounts_ListByBillingAccount (new)
Description :  Lists the enrollment accounts for a billing account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: It is an organizational hierarchy within a billing account to administer and manage azure costs. ,
Required: False ,
}
{
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
departmentDisplayName:
{
Description: The name of the department under which the enrollment account exists. ,
Required: False ,
}
string ,
departmentId:
{
Description: The ID that uniquely identifies the department. ,
Required: False ,
}
string ,
isDevTestEnabled:
{
Description: Boolean flag which enables subscribers to run development and testing workloads on Azure at special Dev/Test rates. ,
Required: False ,
}
boolean ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
authType:
{
Description: The authorization type of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The date from which the enrollment account became valid and functional. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date of expiration of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date ,
Required: False ,
}
string ,
periodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: An invoice. ,
Required: False ,
}
{
amountDue:
{
Description: The amount due as of now. ,
Required: False ,
}
string ,
azurePrepaymentApplied:
{
Description: The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
billedAmount:
{
Description: The total charges for the invoice billing period. ,
Required: False ,
}
string ,
billedDocumentId:
{
Description: The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
creditAmount:
{
Description: The total refund for returns and cancellations during the invoice billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
creditForDocumentId:
{
Description: The Id of the invoice which got voided and this credit note was issued as a result. This field is applicable to the credit notes only. ,
Required: False ,
}
string ,
documents:
{
Description: List of documents available to download and view such as invoice, credit note, or tax receipt. ,
Required: False ,
}
[
{
documentNumbers:
{
Description: The document numbers for the invoice document. ,
Required: False ,
}
[
string ,
]
,
externalUrl:
{
Description: The URL to download the invoice document if the source is external to Microsoft.Billing. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the document. ,
Enum:
{
Other: No description available. ,
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
Summary: No description available. ,
Transactions: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The ID that uniquely identifies an invoice document. This ID may be an identifier for an invoice PDF, a credit note, or a tax receipt. ,
Required: False ,
}
string ,
url:
{
Description: The URL to download the invoice document if the source is internal to Microsoft.Billing. ,
Required: False ,
}
string ,
source:
{
Description: The source of the document. ENF for Brazil and DRS for rest of the world. ,
Enum:
{
Other: No description available. ,
DRS: No description available. ,
ENF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
documentType:
{
Description: The type of the document. ,
Enum:
{
Other: No description available. ,
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
Summary: No description available. ,
Transactions: No description available. ,
}
,
Required: False ,
}
enum ,
dueDate:
{
Description: The due date for the invoice. ,
Format: date-time ,
Required: False ,
}
string ,
failedPayments:
{
Description: List of failed payments. ,
Required: False ,
}
[
{
date:
{
Description: The date when the payment was attempted. ,
Format: date-time ,
Required: False ,
}
string ,
failedPaymentReason:
{
Description: The reason that the payment failed. ,
Enum:
{
Other: No description available. ,
BankDeclined: No description available. ,
CardExpired: No description available. ,
IncorrectCardDetails: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
freeAzureCreditApplied:
{
Description: The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when the invoice was generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceType:
{
Description: Invoice type. ,
Enum:
{
Other: No description available. ,
AzureServices: No description available. ,
AzureMarketplace: No description available. ,
AzureSupport: No description available. ,
}
,
Required: False ,
}
enum ,
isMonthlyInvoice:
{
Description: Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
boolean ,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
amount:
{
Description: The paid amount. ,
Required: False ,
}
string ,
date:
{
Description: The date when the payment was made. ,
Format: date-time ,
Required: False ,
}
string ,
paymentMethodId:
{
Description: The ID that uniquely identifies the payment method used for the invoice. ,
Required: False ,
}
string ,
paymentMethodFamily:
{
Description: The family of payment method. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
}
,
]
,
purchaseOrderNumber:
{
Description: An optional purchase order number for the invoice. ,
Required: False ,
}
string ,
rebillDetails:
{
Description: Rebill details for an invoice. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the invoice. ,
Enum:
{
Other: No description available. ,
Due: No description available. ,
OverDue: No description available. ,
Paid: No description available. ,
Void: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionDisplayName:
{
Description: The name of the billing subscription for which the invoice is generated. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
Required: False ,
}
string ,
specialTaxationType:
{
Description: Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic. ,
Enum:
{
SubtotalLevel: No description available. ,
InvoiceLevel: No description available. ,
}
,
Required: False ,
}
enum ,
subTotal:
{
Description: The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
taxAmount:
{
Description: The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
totalAmount:
{
Description: The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
refundDetails:
{
Description: The details of a refund request. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Invoices_DownloadDocumentsByBillingAccount (new)
Description :  Gets a URL to download multiple invoice documents (invoice pdf, tax receipts, credit notes) as a zip file. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/downloadDocuments
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: A list of download details for individual documents. ,
Required: True ,
}
{
documentName:
{
Description: The ID that uniquely identifies an invoice document. This ID may be an identifier for an invoice PDF, a credit note, or a tax receipt. If omitted, the most recent invoice PDF for the invoice will be returned. ,
Required: False ,
}
string ,
invoiceName:
{
Description: The ID that uniquely identifies an invoice. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

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

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Invoices_Amend (new)
Description :  Regenerate an invoice by billing account name and invoice name. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Invoices_DownloadByBillingAccount (new)
Description :  Gets a URL to download an invoice document. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/download
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
invoiceName:
{
Description: The ID that uniquely identifies an invoice. ,
Required: True ,
}
string ,
documentName:
{
Description: The ID that uniquely identifies an invoice document. This ID may be an identifier for an invoice PDF, a credit note, or a tax receipt. ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Invoices_DownloadSummaryByBillingAccount (new)
Description :  Gets a URL to download the summary document for an invoice. The operation is supported for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Invoices_GetByBillingAccount (new)
Description :  Gets an invoice by billing account name and ID. The operation is supported for all billing account types.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: An invoice. ,
Required: False ,
}
{
amountDue:
{
Description: The amount due as of now. ,
Required: False ,
}
string ,
azurePrepaymentApplied:
{
Description: The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
billedAmount:
{
Description: The total charges for the invoice billing period. ,
Required: False ,
}
string ,
billedDocumentId:
{
Description: The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
creditAmount:
{
Description: The total refund for returns and cancellations during the invoice billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
creditForDocumentId:
{
Description: The Id of the invoice which got voided and this credit note was issued as a result. This field is applicable to the credit notes only. ,
Required: False ,
}
string ,
documents:
{
Description: List of documents available to download and view such as invoice, credit note, or tax receipt. ,
Required: False ,
}
[
{
documentNumbers:
{
Description: The document numbers for the invoice document. ,
Required: False ,
}
[
string ,
]
,
externalUrl:
{
Description: The URL to download the invoice document if the source is external to Microsoft.Billing. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the document. ,
Enum:
{
Other: No description available. ,
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
Summary: No description available. ,
Transactions: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The ID that uniquely identifies an invoice document. This ID may be an identifier for an invoice PDF, a credit note, or a tax receipt. ,
Required: False ,
}
string ,
url:
{
Description: The URL to download the invoice document if the source is internal to Microsoft.Billing. ,
Required: False ,
}
string ,
source:
{
Description: The source of the document. ENF for Brazil and DRS for rest of the world. ,
Enum:
{
Other: No description available. ,
DRS: No description available. ,
ENF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
documentType:
{
Description: The type of the document. ,
Enum:
{
Other: No description available. ,
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
Summary: No description available. ,
Transactions: No description available. ,
}
,
Required: False ,
}
enum ,
dueDate:
{
Description: The due date for the invoice. ,
Format: date-time ,
Required: False ,
}
string ,
failedPayments:
{
Description: List of failed payments. ,
Required: False ,
}
[
{
date:
{
Description: The date when the payment was attempted. ,
Format: date-time ,
Required: False ,
}
string ,
failedPaymentReason:
{
Description: The reason that the payment failed. ,
Enum:
{
Other: No description available. ,
BankDeclined: No description available. ,
CardExpired: No description available. ,
IncorrectCardDetails: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
freeAzureCreditApplied:
{
Description: The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when the invoice was generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceType:
{
Description: Invoice type. ,
Enum:
{
Other: No description available. ,
AzureServices: No description available. ,
AzureMarketplace: No description available. ,
AzureSupport: No description available. ,
}
,
Required: False ,
}
enum ,
isMonthlyInvoice:
{
Description: Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
boolean ,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
amount:
{
Description: The paid amount. ,
Required: False ,
}
string ,
date:
{
Description: The date when the payment was made. ,
Format: date-time ,
Required: False ,
}
string ,
paymentMethodId:
{
Description: The ID that uniquely identifies the payment method used for the invoice. ,
Required: False ,
}
string ,
paymentMethodFamily:
{
Description: The family of payment method. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
}
,
]
,
purchaseOrderNumber:
{
Description: An optional purchase order number for the invoice. ,
Required: False ,
}
string ,
rebillDetails:
{
Description: Rebill details for an invoice. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the invoice. ,
Enum:
{
Other: No description available. ,
Due: No description available. ,
OverDue: No description available. ,
Paid: No description available. ,
Void: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionDisplayName:
{
Description: The name of the billing subscription for which the invoice is generated. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
Required: False ,
}
string ,
specialTaxationType:
{
Description: Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic. ,
Enum:
{
SubtotalLevel: No description available. ,
InvoiceLevel: No description available. ,
}
,
Required: False ,
}
enum ,
subTotal:
{
Description: The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
taxAmount:
{
Description: The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
totalAmount:
{
Description: The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
refundDetails:
{
Description: The details of a refund request. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Invoices_ListByBillingAccount (new)
Description :  Lists the invoices for a billing account for a given start date and end date. The operation is supported for all billing account types.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date ,
Required: False ,
}
string ,
periodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: An invoice. ,
Required: False ,
}
{
amountDue:
{
Description: The amount due as of now. ,
Required: False ,
}
string ,
azurePrepaymentApplied:
{
Description: The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
billedAmount:
{
Description: The total charges for the invoice billing period. ,
Required: False ,
}
string ,
billedDocumentId:
{
Description: The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
creditAmount:
{
Description: The total refund for returns and cancellations during the invoice billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
creditForDocumentId:
{
Description: The Id of the invoice which got voided and this credit note was issued as a result. This field is applicable to the credit notes only. ,
Required: False ,
}
string ,
documents:
{
Description: List of documents available to download and view such as invoice, credit note, or tax receipt. ,
Required: False ,
}
[
{
documentNumbers:
{
Description: The document numbers for the invoice document. ,
Required: False ,
}
[
string ,
]
,
externalUrl:
{
Description: The URL to download the invoice document if the source is external to Microsoft.Billing. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the document. ,
Enum:
{
Other: No description available. ,
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
Summary: No description available. ,
Transactions: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The ID that uniquely identifies an invoice document. This ID may be an identifier for an invoice PDF, a credit note, or a tax receipt. ,
Required: False ,
}
string ,
url:
{
Description: The URL to download the invoice document if the source is internal to Microsoft.Billing. ,
Required: False ,
}
string ,
source:
{
Description: The source of the document. ENF for Brazil and DRS for rest of the world. ,
Enum:
{
Other: No description available. ,
DRS: No description available. ,
ENF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
documentType:
{
Description: The type of the document. ,
Enum:
{
Other: No description available. ,
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
Summary: No description available. ,
Transactions: No description available. ,
}
,
Required: False ,
}
enum ,
dueDate:
{
Description: The due date for the invoice. ,
Format: date-time ,
Required: False ,
}
string ,
failedPayments:
{
Description: List of failed payments. ,
Required: False ,
}
[
{
date:
{
Description: The date when the payment was attempted. ,
Format: date-time ,
Required: False ,
}
string ,
failedPaymentReason:
{
Description: The reason that the payment failed. ,
Enum:
{
Other: No description available. ,
BankDeclined: No description available. ,
CardExpired: No description available. ,
IncorrectCardDetails: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
freeAzureCreditApplied:
{
Description: The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when the invoice was generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceType:
{
Description: Invoice type. ,
Enum:
{
Other: No description available. ,
AzureServices: No description available. ,
AzureMarketplace: No description available. ,
AzureSupport: No description available. ,
}
,
Required: False ,
}
enum ,
isMonthlyInvoice:
{
Description: Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
boolean ,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
amount:
{
Description: The paid amount. ,
Required: False ,
}
string ,
date:
{
Description: The date when the payment was made. ,
Format: date-time ,
Required: False ,
}
string ,
paymentMethodId:
{
Description: The ID that uniquely identifies the payment method used for the invoice. ,
Required: False ,
}
string ,
paymentMethodFamily:
{
Description: The family of payment method. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
}
,
]
,
purchaseOrderNumber:
{
Description: An optional purchase order number for the invoice. ,
Required: False ,
}
string ,
rebillDetails:
{
Description: Rebill details for an invoice. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the invoice. ,
Enum:
{
Other: No description available. ,
Due: No description available. ,
OverDue: No description available. ,
Paid: No description available. ,
Void: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionDisplayName:
{
Description: The name of the billing subscription for which the invoice is generated. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
Required: False ,
}
string ,
specialTaxationType:
{
Description: Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic. ,
Enum:
{
SubtotalLevel: No description available. ,
InvoiceLevel: No description available. ,
}
,
Required: False ,
}
enum ,
subTotal:
{
Description: The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
taxAmount:
{
Description: The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
totalAmount:
{
Description: The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
refundDetails:
{
Description: The details of a refund request. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Invoices_DownloadDocumentsByBillingSubscription (new)
Description :  Gets a URL to download multiple invoice documents (invoice pdf, tax receipts, credit notes) as a zip file. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/downloadDocuments
{
subscriptionId:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: A list of download details for individual documents. ,
Required: True ,
}
{
documentName:
{
Description: The ID that uniquely identifies an invoice document. This ID may be an identifier for an invoice PDF, a credit note, or a tax receipt. If omitted, the most recent invoice PDF for the invoice will be returned. ,
Required: False ,
}
string ,
invoiceName:
{
Description: The ID that uniquely identifies an invoice. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

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

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Invoices_DownloadByBillingSubscription (new)
Description :  Gets a URL to download an invoice by billing subscription. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices/{invoiceName}/download
{
subscriptionId:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: True ,
}
string ,
invoiceName:
{
Description: The ID that uniquely identifies an invoice. ,
Required: True ,
}
string ,
documentName:
{
Description: The ID that uniquely identifies an invoice document. This ID may be an identifier for an invoice PDF, a credit note, or a tax receipt. ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Invoices_GetByBillingSubscription (new)
Description :  Gets an invoice by subscription ID and invoice ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: An invoice. ,
Required: False ,
}
{
amountDue:
{
Description: The amount due as of now. ,
Required: False ,
}
string ,
azurePrepaymentApplied:
{
Description: The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
billedAmount:
{
Description: The total charges for the invoice billing period. ,
Required: False ,
}
string ,
billedDocumentId:
{
Description: The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
creditAmount:
{
Description: The total refund for returns and cancellations during the invoice billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
creditForDocumentId:
{
Description: The Id of the invoice which got voided and this credit note was issued as a result. This field is applicable to the credit notes only. ,
Required: False ,
}
string ,
documents:
{
Description: List of documents available to download and view such as invoice, credit note, or tax receipt. ,
Required: False ,
}
[
{
documentNumbers:
{
Description: The document numbers for the invoice document. ,
Required: False ,
}
[
string ,
]
,
externalUrl:
{
Description: The URL to download the invoice document if the source is external to Microsoft.Billing. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the document. ,
Enum:
{
Other: No description available. ,
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
Summary: No description available. ,
Transactions: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The ID that uniquely identifies an invoice document. This ID may be an identifier for an invoice PDF, a credit note, or a tax receipt. ,
Required: False ,
}
string ,
url:
{
Description: The URL to download the invoice document if the source is internal to Microsoft.Billing. ,
Required: False ,
}
string ,
source:
{
Description: The source of the document. ENF for Brazil and DRS for rest of the world. ,
Enum:
{
Other: No description available. ,
DRS: No description available. ,
ENF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
documentType:
{
Description: The type of the document. ,
Enum:
{
Other: No description available. ,
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
Summary: No description available. ,
Transactions: No description available. ,
}
,
Required: False ,
}
enum ,
dueDate:
{
Description: The due date for the invoice. ,
Format: date-time ,
Required: False ,
}
string ,
failedPayments:
{
Description: List of failed payments. ,
Required: False ,
}
[
{
date:
{
Description: The date when the payment was attempted. ,
Format: date-time ,
Required: False ,
}
string ,
failedPaymentReason:
{
Description: The reason that the payment failed. ,
Enum:
{
Other: No description available. ,
BankDeclined: No description available. ,
CardExpired: No description available. ,
IncorrectCardDetails: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
freeAzureCreditApplied:
{
Description: The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when the invoice was generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceType:
{
Description: Invoice type. ,
Enum:
{
Other: No description available. ,
AzureServices: No description available. ,
AzureMarketplace: No description available. ,
AzureSupport: No description available. ,
}
,
Required: False ,
}
enum ,
isMonthlyInvoice:
{
Description: Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
boolean ,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
amount:
{
Description: The paid amount. ,
Required: False ,
}
string ,
date:
{
Description: The date when the payment was made. ,
Format: date-time ,
Required: False ,
}
string ,
paymentMethodId:
{
Description: The ID that uniquely identifies the payment method used for the invoice. ,
Required: False ,
}
string ,
paymentMethodFamily:
{
Description: The family of payment method. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
}
,
]
,
purchaseOrderNumber:
{
Description: An optional purchase order number for the invoice. ,
Required: False ,
}
string ,
rebillDetails:
{
Description: Rebill details for an invoice. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the invoice. ,
Enum:
{
Other: No description available. ,
Due: No description available. ,
OverDue: No description available. ,
Paid: No description available. ,
Void: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionDisplayName:
{
Description: The name of the billing subscription for which the invoice is generated. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
Required: False ,
}
string ,
specialTaxationType:
{
Description: Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic. ,
Enum:
{
SubtotalLevel: No description available. ,
InvoiceLevel: No description available. ,
}
,
Required: False ,
}
enum ,
subTotal:
{
Description: The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
taxAmount:
{
Description: The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
totalAmount:
{
Description: The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
refundDetails:
{
Description: The details of a refund request. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Invoices_ListByBillingSubscription (new)
Description :  Lists the invoices for a subscription. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices
{
subscriptionId:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date ,
Required: False ,
}
string ,
periodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: An invoice. ,
Required: False ,
}
{
amountDue:
{
Description: The amount due as of now. ,
Required: False ,
}
string ,
azurePrepaymentApplied:
{
Description: The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
billedAmount:
{
Description: The total charges for the invoice billing period. ,
Required: False ,
}
string ,
billedDocumentId:
{
Description: The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
creditAmount:
{
Description: The total refund for returns and cancellations during the invoice billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
creditForDocumentId:
{
Description: The Id of the invoice which got voided and this credit note was issued as a result. This field is applicable to the credit notes only. ,
Required: False ,
}
string ,
documents:
{
Description: List of documents available to download and view such as invoice, credit note, or tax receipt. ,
Required: False ,
}
[
{
documentNumbers:
{
Description: The document numbers for the invoice document. ,
Required: False ,
}
[
string ,
]
,
externalUrl:
{
Description: The URL to download the invoice document if the source is external to Microsoft.Billing. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the document. ,
Enum:
{
Other: No description available. ,
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
Summary: No description available. ,
Transactions: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The ID that uniquely identifies an invoice document. This ID may be an identifier for an invoice PDF, a credit note, or a tax receipt. ,
Required: False ,
}
string ,
url:
{
Description: The URL to download the invoice document if the source is internal to Microsoft.Billing. ,
Required: False ,
}
string ,
source:
{
Description: The source of the document. ENF for Brazil and DRS for rest of the world. ,
Enum:
{
Other: No description available. ,
DRS: No description available. ,
ENF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
documentType:
{
Description: The type of the document. ,
Enum:
{
Other: No description available. ,
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
Summary: No description available. ,
Transactions: No description available. ,
}
,
Required: False ,
}
enum ,
dueDate:
{
Description: The due date for the invoice. ,
Format: date-time ,
Required: False ,
}
string ,
failedPayments:
{
Description: List of failed payments. ,
Required: False ,
}
[
{
date:
{
Description: The date when the payment was attempted. ,
Format: date-time ,
Required: False ,
}
string ,
failedPaymentReason:
{
Description: The reason that the payment failed. ,
Enum:
{
Other: No description available. ,
BankDeclined: No description available. ,
CardExpired: No description available. ,
IncorrectCardDetails: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
freeAzureCreditApplied:
{
Description: The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when the invoice was generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceType:
{
Description: Invoice type. ,
Enum:
{
Other: No description available. ,
AzureServices: No description available. ,
AzureMarketplace: No description available. ,
AzureSupport: No description available. ,
}
,
Required: False ,
}
enum ,
isMonthlyInvoice:
{
Description: Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
boolean ,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
amount:
{
Description: The paid amount. ,
Required: False ,
}
string ,
date:
{
Description: The date when the payment was made. ,
Format: date-time ,
Required: False ,
}
string ,
paymentMethodId:
{
Description: The ID that uniquely identifies the payment method used for the invoice. ,
Required: False ,
}
string ,
paymentMethodFamily:
{
Description: The family of payment method. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
}
,
]
,
purchaseOrderNumber:
{
Description: An optional purchase order number for the invoice. ,
Required: False ,
}
string ,
rebillDetails:
{
Description: Rebill details for an invoice. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the invoice. ,
Enum:
{
Other: No description available. ,
Due: No description available. ,
OverDue: No description available. ,
Paid: No description available. ,
Void: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionDisplayName:
{
Description: The name of the billing subscription for which the invoice is generated. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
Required: False ,
}
string ,
specialTaxationType:
{
Description: Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic. ,
Enum:
{
SubtotalLevel: No description available. ,
InvoiceLevel: No description available. ,
}
,
Required: False ,
}
enum ,
subTotal:
{
Description: The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
taxAmount:
{
Description: The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
totalAmount:
{
Description: The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
refundDetails:
{
Description: The details of a refund request. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Invoices_Get (new)
Description :  Gets an invoice by ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/default/invoices/{invoiceName}
{
invoiceName:
{
Description: The ID that uniquely identifies an invoice. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: An invoice. ,
Required: False ,
}
{
amountDue:
{
Description: The amount due as of now. ,
Required: False ,
}
string ,
azurePrepaymentApplied:
{
Description: The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
billedAmount:
{
Description: The total charges for the invoice billing period. ,
Required: False ,
}
string ,
billedDocumentId:
{
Description: The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
creditAmount:
{
Description: The total refund for returns and cancellations during the invoice billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
creditForDocumentId:
{
Description: The Id of the invoice which got voided and this credit note was issued as a result. This field is applicable to the credit notes only. ,
Required: False ,
}
string ,
documents:
{
Description: List of documents available to download and view such as invoice, credit note, or tax receipt. ,
Required: False ,
}
[
{
documentNumbers:
{
Description: The document numbers for the invoice document. ,
Required: False ,
}
[
string ,
]
,
externalUrl:
{
Description: The URL to download the invoice document if the source is external to Microsoft.Billing. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the document. ,
Enum:
{
Other: No description available. ,
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
Summary: No description available. ,
Transactions: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The ID that uniquely identifies an invoice document. This ID may be an identifier for an invoice PDF, a credit note, or a tax receipt. ,
Required: False ,
}
string ,
url:
{
Description: The URL to download the invoice document if the source is internal to Microsoft.Billing. ,
Required: False ,
}
string ,
source:
{
Description: The source of the document. ENF for Brazil and DRS for rest of the world. ,
Enum:
{
Other: No description available. ,
DRS: No description available. ,
ENF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
documentType:
{
Description: The type of the document. ,
Enum:
{
Other: No description available. ,
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
Summary: No description available. ,
Transactions: No description available. ,
}
,
Required: False ,
}
enum ,
dueDate:
{
Description: The due date for the invoice. ,
Format: date-time ,
Required: False ,
}
string ,
failedPayments:
{
Description: List of failed payments. ,
Required: False ,
}
[
{
date:
{
Description: The date when the payment was attempted. ,
Format: date-time ,
Required: False ,
}
string ,
failedPaymentReason:
{
Description: The reason that the payment failed. ,
Enum:
{
Other: No description available. ,
BankDeclined: No description available. ,
CardExpired: No description available. ,
IncorrectCardDetails: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
freeAzureCreditApplied:
{
Description: The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when the invoice was generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceType:
{
Description: Invoice type. ,
Enum:
{
Other: No description available. ,
AzureServices: No description available. ,
AzureMarketplace: No description available. ,
AzureSupport: No description available. ,
}
,
Required: False ,
}
enum ,
isMonthlyInvoice:
{
Description: Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
boolean ,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
amount:
{
Description: The paid amount. ,
Required: False ,
}
string ,
date:
{
Description: The date when the payment was made. ,
Format: date-time ,
Required: False ,
}
string ,
paymentMethodId:
{
Description: The ID that uniquely identifies the payment method used for the invoice. ,
Required: False ,
}
string ,
paymentMethodFamily:
{
Description: The family of payment method. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
}
,
]
,
purchaseOrderNumber:
{
Description: An optional purchase order number for the invoice. ,
Required: False ,
}
string ,
rebillDetails:
{
Description: Rebill details for an invoice. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the invoice. ,
Enum:
{
Other: No description available. ,
Due: No description available. ,
OverDue: No description available. ,
Paid: No description available. ,
Void: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionDisplayName:
{
Description: The name of the billing subscription for which the invoice is generated. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
Required: False ,
}
string ,
specialTaxationType:
{
Description: Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic. ,
Enum:
{
SubtotalLevel: No description available. ,
InvoiceLevel: No description available. ,
}
,
Required: False ,
}
enum ,
subTotal:
{
Description: The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
taxAmount:
{
Description: The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
totalAmount:
{
Description: The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
refundDetails:
{
Description: The details of a refund request. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InvoiceSections_ValidateDeleteEligibility (new)
Description :  Validates if the invoice section can be deleted. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
eligibilityStatus:
{
Description: Status describing if invoice section is eligible to be deleted. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
eligibilityDetails:
{
Description: A list of delete invoice section eligibility result details. ,
Required: False ,
}
[
{
code:
{
Description: Code for the delete invoice section validation. ,
Enum:
{
Other: No description available. ,
LastInvoiceSection: No description available. ,
ActiveAzurePlans: No description available. ,
ReservedInstances: No description available. ,
ActiveBillingSubscriptions: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InvoiceSections_Delete (new)
Description :  Deletes an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InvoiceSections_Get (new)
Description :  Gets an invoice section by its ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: An invoice section. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the status of an invoice section. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
Disabled: No description available. ,
UnderReview: No description available. ,
Warned: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
reasonCode:
{
Description: Reason for the specified invoice section status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InvoiceSections_CreateOrUpdate (new)
Description :  Creates or updates an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: An invoice section. ,
Required: True ,
}
{
properties:
{
Description: An invoice section. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the status of an invoice section. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
Disabled: No description available. ,
UnderReview: No description available. ,
Warned: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
reasonCode:
{
Description: Reason for the specified invoice section status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: An invoice section. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the status of an invoice section. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
Disabled: No description available. ,
UnderReview: No description available. ,
Warned: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
reasonCode:
{
Description: Reason for the specified invoice section status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: An invoice section. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the status of an invoice section. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
Disabled: No description available. ,
UnderReview: No description available. ,
Warned: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
reasonCode:
{
Description: Reason for the specified invoice section status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
includeDeleted:
{
Description: Can be used to get deleted invoice sections. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: An invoice section. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the status of an invoice section. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
Disabled: No description available. ,
UnderReview: No description available. ,
Warned: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
reasonCode:
{
Description: Reason for the specified invoice section status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  List of operations supported by provider.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action". ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PaymentMethods_ListByBillingProfile (new)
Description :  Lists payment methods attached to a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of payment method links. ,
Required: False ,
}
[
{
properties:
{
Description: Payment method link properties ,
Required: False ,
}
{
accountHolderName:
{
Description: The account holder name for the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the payment method. ,
Required: False ,
}
string ,
expiration:
{
Description: The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
family:
{
Description: The family of payment method. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
lastFourDigits:
{
Description: Last four digits of payment method. ,
Required: False ,
}
string ,
logos:
{
Description: The list of logos for the payment method. ,
Required: False ,
}
[
{
mimeType:
{
Description: MIME type of the logo. ,
Required: False ,
}
string ,
url:
{
Description: Public URL of image of the logo. ,
Required: False ,
}
string ,
}
,
]
,
paymentMethod:
{
Description: Projection of a payment method. Will not be returned in this or future versions. ,
Required: False ,
}
{
id:
{
Description: Id of payment method. ,
Required: False ,
}
string ,
accountHolderName:
{
Description: The account holder name for the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the payment method. ,
Required: False ,
}
string ,
expiration:
{
Description: The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
family:
{
Description: The family of payment method. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
lastFourDigits:
{
Description: Last four digits of payment method. ,
Required: False ,
}
string ,
logos:
{
Description: The list of logos for the payment method. ,
Required: False ,
}
[
{
mimeType:
{
Description: MIME type of the logo. ,
Required: False ,
}
string ,
url:
{
Description: Public URL of image of the logo. ,
Required: False ,
}
string ,
}
,
]
,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
status:
{
Description: Status of the payment method. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
paymentMethodId:
{
Description: Id of payment method. Example: /providers/Microsoft.Billing/paymentMethods/ABCDABCDABC0 ,
Required: False ,
}
string ,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
status:
{
Description: Status of the payment method. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PaymentMethods_GetByBillingProfile (new)
Description :  Gets a payment method linked with a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Payment method link properties ,
Required: False ,
}
{
accountHolderName:
{
Description: The account holder name for the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the payment method. ,
Required: False ,
}
string ,
expiration:
{
Description: The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
family:
{
Description: The family of payment method. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
lastFourDigits:
{
Description: Last four digits of payment method. ,
Required: False ,
}
string ,
logos:
{
Description: The list of logos for the payment method. ,
Required: False ,
}
[
{
mimeType:
{
Description: MIME type of the logo. ,
Required: False ,
}
string ,
url:
{
Description: Public URL of image of the logo. ,
Required: False ,
}
string ,
}
,
]
,
paymentMethod:
{
Description: Projection of a payment method. Will not be returned in this or future versions. ,
Required: False ,
}
{
id:
{
Description: Id of payment method. ,
Required: False ,
}
string ,
accountHolderName:
{
Description: The account holder name for the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the payment method. ,
Required: False ,
}
string ,
expiration:
{
Description: The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
family:
{
Description: The family of payment method. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
lastFourDigits:
{
Description: Last four digits of payment method. ,
Required: False ,
}
string ,
logos:
{
Description: The list of logos for the payment method. ,
Required: False ,
}
[
{
mimeType:
{
Description: MIME type of the logo. ,
Required: False ,
}
string ,
url:
{
Description: Public URL of image of the logo. ,
Required: False ,
}
string ,
}
,
]
,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
status:
{
Description: Status of the payment method. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
paymentMethodId:
{
Description: Id of payment method. Example: /providers/Microsoft.Billing/paymentMethods/ABCDABCDABC0 ,
Required: False ,
}
string ,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
status:
{
Description: Status of the payment method. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PaymentMethods_ListByBillingAccount (new)
Description :  Lists the payment methods available for a billing account. Along with the payment methods owned by the caller, these payment methods can be attached to a billing profile to make payments. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of payment methods. ,
Required: False ,
}
[
{
properties:
{
Description: Payment method properties ,
Required: False ,
}
{
id:
{
Description: Id of payment method. ,
Required: False ,
}
string ,
accountHolderName:
{
Description: The account holder name for the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the payment method. ,
Required: False ,
}
string ,
expiration:
{
Description: The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
family:
{
Description: The family of payment method. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
lastFourDigits:
{
Description: Last four digits of payment method. ,
Required: False ,
}
string ,
logos:
{
Description: The list of logos for the payment method. ,
Required: False ,
}
[
{
mimeType:
{
Description: MIME type of the logo. ,
Required: False ,
}
string ,
url:
{
Description: Public URL of image of the logo. ,
Required: False ,
}
string ,
}
,
]
,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
status:
{
Description: Status of the payment method. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PaymentMethods_GetByBillingAccount (new)
Description :  Gets a payment method available for a billing account. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Payment method properties ,
Required: False ,
}
{
id:
{
Description: Id of payment method. ,
Required: False ,
}
string ,
accountHolderName:
{
Description: The account holder name for the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the payment method. ,
Required: False ,
}
string ,
expiration:
{
Description: The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
family:
{
Description: The family of payment method. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
lastFourDigits:
{
Description: Last four digits of payment method. ,
Required: False ,
}
string ,
logos:
{
Description: The list of logos for the payment method. ,
Required: False ,
}
[
{
mimeType:
{
Description: MIME type of the logo. ,
Required: False ,
}
string ,
url:
{
Description: Public URL of image of the logo. ,
Required: False ,
}
string ,
}
,
]
,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
status:
{
Description: Status of the payment method. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PaymentMethods_ListByUser (new)
Description :  Lists the payment methods owned by the caller.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of payment methods. ,
Required: False ,
}
[
{
properties:
{
Description: Payment method properties ,
Required: False ,
}
{
id:
{
Description: Id of payment method. ,
Required: False ,
}
string ,
accountHolderName:
{
Description: The account holder name for the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the payment method. ,
Required: False ,
}
string ,
expiration:
{
Description: The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
family:
{
Description: The family of payment method. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
lastFourDigits:
{
Description: Last four digits of payment method. ,
Required: False ,
}
string ,
logos:
{
Description: The list of logos for the payment method. ,
Required: False ,
}
[
{
mimeType:
{
Description: MIME type of the logo. ,
Required: False ,
}
string ,
url:
{
Description: Public URL of image of the logo. ,
Required: False ,
}
string ,
}
,
]
,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
status:
{
Description: Status of the payment method. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PaymentMethods_DeleteByUser (new)
Description :  Deletes a payment method owned by the caller.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/paymentMethods/{paymentMethodName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
paymentMethodName:
{
Description: The ID that uniquely identifies a payment method. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PaymentMethods_GetByUser (new)
Description :  Gets a payment method owned by the caller.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/paymentMethods/{paymentMethodName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
paymentMethodName:
{
Description: The ID that uniquely identifies a payment method. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Payment method properties ,
Required: False ,
}
{
id:
{
Description: Id of payment method. ,
Required: False ,
}
string ,
accountHolderName:
{
Description: The account holder name for the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the payment method. ,
Required: False ,
}
string ,
expiration:
{
Description: The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
family:
{
Description: The family of payment method. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
lastFourDigits:
{
Description: Last four digits of payment method. ,
Required: False ,
}
string ,
logos:
{
Description: The list of logos for the payment method. ,
Required: False ,
}
[
{
mimeType:
{
Description: MIME type of the logo. ,
Required: False ,
}
string ,
url:
{
Description: Public URL of image of the logo. ,
Required: False ,
}
string ,
}
,
]
,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
status:
{
Description: Status of the payment method. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policies_GetByCustomer (new)
Description :  Lists the policies for a customer. This operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/policies/{policyName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
policyName:
{
Description: Service-defined resource names such as 'default' which are reserved resource names. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A policy at customer scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: True ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policies_CreateOrUpdateByCustomer (new)
Description :  Updates the policies for a customer. This operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/policies/default
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: A policy at customer scope. ,
Required: True ,
}
{
properties:
{
Description: A policy at customer scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: True ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A policy at customer scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: True ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
location: string ,
retry-after: integer ,
}
,
$schema:
{
Description: A policy at customer scope. ,
}
{
properties:
{
Description: A policy at customer scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: True ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policies_GetByBillingProfile (new)
Description :  Lists the policies for a billing profile. This operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: A policy at billing profile scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
enterpriseAgreementPolicies:
{
Description: The policies for Enterprise Agreement enrollments. ,
Required: False ,
}
string ,
invoiceSectionLabelManagement:
{
Description: The policy that controls invoice section label management at invoice section scope. This is allowed by default. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
marketplacePurchases:
{
Description: The policy that controls whether Azure marketplace purchases are allowed. ,
Enum:
{
Other: No description available. ,
AllAllowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
OnlyFreeAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
reservationPurchases:
{
Description: The policy that controls whether Azure reservation purchases are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
savingsPlanPurchases:
{
Description: The policy that controls whether users with Azure savings plan purchase are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policies_CreateOrUpdateByBillingProfile (new)
Description :  Updates the policies for a billing profile. This operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/policies/default
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: A policy at billing profile scope. ,
Required: True ,
}
{
properties:
{
Description: A policy at billing profile scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
enterpriseAgreementPolicies:
{
Description: The policies for Enterprise Agreement enrollments. ,
Required: False ,
}
string ,
invoiceSectionLabelManagement:
{
Description: The policy that controls invoice section label management at invoice section scope. This is allowed by default. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
marketplacePurchases:
{
Description: The policy that controls whether Azure marketplace purchases are allowed. ,
Enum:
{
Other: No description available. ,
AllAllowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
OnlyFreeAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
reservationPurchases:
{
Description: The policy that controls whether Azure reservation purchases are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
savingsPlanPurchases:
{
Description: The policy that controls whether users with Azure savings plan purchase are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A policy at billing profile scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
enterpriseAgreementPolicies:
{
Description: The policies for Enterprise Agreement enrollments. ,
Required: False ,
}
string ,
invoiceSectionLabelManagement:
{
Description: The policy that controls invoice section label management at invoice section scope. This is allowed by default. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
marketplacePurchases:
{
Description: The policy that controls whether Azure marketplace purchases are allowed. ,
Enum:
{
Other: No description available. ,
AllAllowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
OnlyFreeAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
reservationPurchases:
{
Description: The policy that controls whether Azure reservation purchases are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
savingsPlanPurchases:
{
Description: The policy that controls whether users with Azure savings plan purchase are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
location: string ,
retry-after: integer ,
}
,
$schema:
{
Description: A policy at billing profile scope. ,
}
{
properties:
{
Description: A policy at billing profile scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
enterpriseAgreementPolicies:
{
Description: The policies for Enterprise Agreement enrollments. ,
Required: False ,
}
string ,
invoiceSectionLabelManagement:
{
Description: The policy that controls invoice section label management at invoice section scope. This is allowed by default. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
marketplacePurchases:
{
Description: The policy that controls whether Azure marketplace purchases are allowed. ,
Enum:
{
Other: No description available. ,
AllAllowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
OnlyFreeAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
reservationPurchases:
{
Description: The policy that controls whether Azure reservation purchases are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
savingsPlanPurchases:
{
Description: The policy that controls whether users with Azure savings plan purchase are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policies_GetByCustomerAtBillingAccount (new)
Description :  Lists the policies for a customer at billing account scope. This operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: A policy at customer scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: True ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policies_CreateOrUpdateByCustomerAtBillingAccount (new)
Description :  Updates the policies for a customer at billing account scope. This operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/policies/default
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: A policy at customer scope. ,
Required: True ,
}
{
properties:
{
Description: A policy at customer scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: True ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A policy at customer scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: True ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
location: string ,
retry-after: integer ,
}
,
$schema:
{
Description: A policy at customer scope. ,
}
{
properties:
{
Description: A policy at customer scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: True ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policies_GetByBillingAccount (new)
Description :  Get the policies for a billing account of Enterprise Agreement type.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: A policy at billing account scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
enterpriseAgreementPolicies:
{
Description: The policies for Enterprise Agreement enrollments. ,
Required: False ,
}
string ,
marketplacePurchases:
{
Description: The policy that controls whether Azure marketplace purchases are allowed. ,
Enum:
{
Other: No description available. ,
AllAllowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
OnlyFreeAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
reservationPurchases:
{
Description: The policy that controls whether Azure reservation purchases are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
savingsPlanPurchases:
{
Description: The policy that controls whether users with Azure savings plan purchase are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policies_CreateOrUpdateByBillingAccount (new)
Description :  Update the policies for a billing account of Enterprise Agreement type.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/policies/default
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: A policy at billing account scope. ,
Required: True ,
}
{
properties:
{
Description: A policy at billing account scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
enterpriseAgreementPolicies:
{
Description: The policies for Enterprise Agreement enrollments. ,
Required: False ,
}
string ,
marketplacePurchases:
{
Description: The policy that controls whether Azure marketplace purchases are allowed. ,
Enum:
{
Other: No description available. ,
AllAllowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
OnlyFreeAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
reservationPurchases:
{
Description: The policy that controls whether Azure reservation purchases are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
savingsPlanPurchases:
{
Description: The policy that controls whether users with Azure savings plan purchase are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A policy at billing account scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
enterpriseAgreementPolicies:
{
Description: The policies for Enterprise Agreement enrollments. ,
Required: False ,
}
string ,
marketplacePurchases:
{
Description: The policy that controls whether Azure marketplace purchases are allowed. ,
Enum:
{
Other: No description available. ,
AllAllowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
OnlyFreeAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
reservationPurchases:
{
Description: The policy that controls whether Azure reservation purchases are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
savingsPlanPurchases:
{
Description: The policy that controls whether users with Azure savings plan purchase are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
location: string ,
retry-after: integer ,
}
,
$schema:
{
Description: A policy at billing account scope. ,
}
{
properties:
{
Description: A policy at billing account scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
enterpriseAgreementPolicies:
{
Description: The policies for Enterprise Agreement enrollments. ,
Required: False ,
}
string ,
marketplacePurchases:
{
Description: The policy that controls whether Azure marketplace purchases are allowed. ,
Enum:
{
Other: No description available. ,
AllAllowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
OnlyFreeAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
reservationPurchases:
{
Description: The policy that controls whether Azure reservation purchases are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
savingsPlanPurchases:
{
Description: The policy that controls whether users with Azure savings plan purchase are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policies_GetBySubscription (new)
Description :  Lists the policies that are managed by the Billing Admin for the defined subscriptions. This is supported for Microsoft Online Services Program, Microsoft Customer Agreement and Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/policies/default
{
subscriptionId:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A policy at subscription scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/products
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A product. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityId:
{
Description: The availability of the product. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The frequency at which the product will be billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
endDate:
{
Description: The date when the product will be renewed or canceled. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
lastCharge:
{
Description: The last month charges. ,
Required: False ,
}
string ,
lastChargeDate:
{
Description: The date of the last charge. ,
Required: False ,
}
string ,
productType:
{
Description: The description of the type of product. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the type of product. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku ID of the product. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date when the product was purchased. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased for the product. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the product. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
PastDue: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Canceled: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The id of the tenant in which the product is used. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this product. The fields is not available for Microsoft Partner Agreement products. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Products_ListByBillingProfile (new)
Description :  Lists the products for a billing profile. These don't include products billed based on usage. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/products
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A product. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityId:
{
Description: The availability of the product. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The frequency at which the product will be billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
endDate:
{
Description: The date when the product will be renewed or canceled. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
lastCharge:
{
Description: The last month charges. ,
Required: False ,
}
string ,
lastChargeDate:
{
Description: The date of the last charge. ,
Required: False ,
}
string ,
productType:
{
Description: The description of the type of product. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the type of product. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku ID of the product. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date when the product was purchased. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased for the product. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the product. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
PastDue: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Canceled: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The id of the tenant in which the product is used. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this product. The fields is not available for Microsoft Partner Agreement products. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/products
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A product. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityId:
{
Description: The availability of the product. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The frequency at which the product will be billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
endDate:
{
Description: The date when the product will be renewed or canceled. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
lastCharge:
{
Description: The last month charges. ,
Required: False ,
}
string ,
lastChargeDate:
{
Description: The date of the last charge. ,
Required: False ,
}
string ,
productType:
{
Description: The description of the type of product. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the type of product. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku ID of the product. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date when the product was purchased. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased for the product. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the product. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
PastDue: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Canceled: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The id of the tenant in which the product is used. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this product. The fields is not available for Microsoft Partner Agreement products. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products/{productName}/move
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
productName:
{
Description: The ID that uniquely identifies a product. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of the product to initiate a transfer. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A product. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityId:
{
Description: The availability of the product. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The frequency at which the product will be billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
endDate:
{
Description: The date when the product will be renewed or canceled. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
lastCharge:
{
Description: The last month charges. ,
Required: False ,
}
string ,
lastChargeDate:
{
Description: The date of the last charge. ,
Required: False ,
}
string ,
productType:
{
Description: The description of the type of product. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the type of product. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku ID of the product. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date when the product was purchased. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased for the product. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the product. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
PastDue: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Canceled: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The id of the tenant in which the product is used. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this product. The fields is not available for Microsoft Partner Agreement products. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

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

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products/{productName}/validateMoveEligibility
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
productName:
{
Description: The ID that uniquely identifies a product. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of the product to initiate a transfer. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
isMoveEligible:
{
Description: Specifies whether the subscription is eligible to be transferred. ,
Required: False ,
}
boolean ,
errorDetails:
{
Description: Error details of the transfer eligibility validation. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Products_Get (new)
Description :  Gets a product by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: A product. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityId:
{
Description: The availability of the product. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The frequency at which the product will be billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
endDate:
{
Description: The date when the product will be renewed or canceled. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
lastCharge:
{
Description: The last month charges. ,
Required: False ,
}
string ,
lastChargeDate:
{
Description: The date of the last charge. ,
Required: False ,
}
string ,
productType:
{
Description: The description of the type of product. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the type of product. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku ID of the product. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date when the product was purchased. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased for the product. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the product. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
PastDue: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Canceled: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The id of the tenant in which the product is used. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this product. The fields is not available for Microsoft Partner Agreement products. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Products_Update (new)
Description :  Updates the properties of a Product. Currently, auto renew can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products/{productName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
productName:
{
Description: The ID that uniquely identifies a product. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: A product. ,
Required: True ,
}
{
properties:
{
Description: A product. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityId:
{
Description: The availability of the product. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The frequency at which the product will be billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
endDate:
{
Description: The date when the product will be renewed or canceled. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
lastCharge:
{
Description: The last month charges. ,
Required: False ,
}
string ,
lastChargeDate:
{
Description: The date of the last charge. ,
Required: False ,
}
string ,
productType:
{
Description: The description of the type of product. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the type of product. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku ID of the product. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date when the product was purchased. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased for the product. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the product. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
PastDue: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Canceled: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The id of the tenant in which the product is used. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this product. The fields is not available for Microsoft Partner Agreement products. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A product. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityId:
{
Description: The availability of the product. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The frequency at which the product will be billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
endDate:
{
Description: The date when the product will be renewed or canceled. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
lastCharge:
{
Description: The last month charges. ,
Required: False ,
}
string ,
lastChargeDate:
{
Description: The date of the last charge. ,
Required: False ,
}
string ,
productType:
{
Description: The description of the type of product. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the type of product. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku ID of the product. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date when the product was purchased. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased for the product. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the product. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
PastDue: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Canceled: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The id of the tenant in which the product is used. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this product. The fields is not available for Microsoft Partner Agreement products. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A product. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityId:
{
Description: The availability of the product. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The frequency at which the product will be billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
endDate:
{
Description: The date when the product will be renewed or canceled. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
lastCharge:
{
Description: The last month charges. ,
Required: False ,
}
string ,
lastChargeDate:
{
Description: The date of the last charge. ,
Required: False ,
}
string ,
productType:
{
Description: The description of the type of product. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the type of product. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku ID of the product. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date when the product was purchased. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased for the product. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the product. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
PastDue: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Canceled: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The id of the tenant in which the product is used. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this product. The fields is not available for Microsoft Partner Agreement products. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Reservations_ListByBillingAccount (new)
Description :  Lists the reservations in the billing account and the roll up counts of reservations group by provisioning states.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservations
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
skiptoken:
{
Description: The number of reservations to skip from the list before returning results ,
Required: False ,
}
number ,
refreshSummary:
{
Description: To indicate whether to refresh the roll up counts of the reservations group by provisioning states ,
Required: False ,
}
string ,
selectedState:
{
Description: The selected provisioning state ,
Required: False ,
}
string ,
take:
{
Description: The number of reservations to return in API response. ,
Required: False ,
}
number ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
summary:
{
Description: The roll out count summary of the reservations ,
Required: False ,
}
{
cancelledCount:
{
Description: The number of reservation in Cancelled state ,
Required: False ,
}
number ,
expiredCount:
{
Description: The number of reservation in Expired state ,
Required: False ,
}
number ,
expiringCount:
{
Description: The number of reservation in Expiring state ,
Required: False ,
}
number ,
failedCount:
{
Description: The number of reservation in Failed state ,
Required: False ,
}
number ,
pendingCount:
{
Description: The number of reservation in Pending state ,
Required: False ,
}
number ,
succeededCount:
{
Description: The number of reservation in Succeeded state ,
Required: False ,
}
number ,
noBenefitCount:
{
Description: The number of reservation in 'No Benefit' state ,
Required: False ,
}
number ,
warningCount:
{
Description: The number of reservation in Warning state ,
Required: False ,
}
number ,
processingCount:
{
Description: The number of reservation in Processing state ,
Required: False ,
}
number ,
}
,
value:
{
Description: The list of reservations. ,
Required: False ,
}
[
{
location:
{
Description: The location of the reservation. ,
Required: False ,
}
string ,
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the reservation ,
Required: False ,
}
string ,
appliedScopes:
{
Description: The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type of the reservation. ,
Required: False ,
}
string ,
archived:
{
Description: Indicates if the reservation is archived ,
Required: False ,
}
boolean ,
capabilities:
{
Description: Capabilities of the reservation ,
Required: False ,
}
string ,
quantity:
{
Description: The number of the reservation. ,
Required: False ,
}
number ,
provisioningState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
effectiveDateTime:
{
Description: The effective date time of the reservation ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: DateTime of the last time the reservation was updated. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: The expiry date of the reservation ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the reservation ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
{
statusCode:
{
Description: The status of the reservation. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
CapacityError: No description available. ,
CapacityRestricted: No description available. ,
Exchanged: No description available. ,
UnknownError: No description available. ,
RiskCheckFailed: No description available. ,
CreditLineCheckFailed: No description available. ,
Warning: No description available. ,
NoBenefitDueToSubscriptionTransfer: No description available. ,
NoBenefitDueToSubscriptionDeletion: No description available. ,
NoBenefit: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties for extended status information ,
Required: False ,
}
{
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
}
,
}
,
billingPlan:
{
Description: The billing plan options available for this sku. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
purchaseDate:
{
Description: This is the date when the reservation was purchased. ,
Format: date ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: This is the date-time when the reservation was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
splitProperties:
{
Description: Properties of reservation split ,
Required: False ,
}
{
splitDestinations:
{
Description: List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
splitSource:
{
Description: Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
mergeProperties:
{
Description: Properties of reservation merge ,
Required: False ,
}
{
mergeDestination:
{
Description: Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
mergeSources:
{
Description: Resource ids of the source reservation's merged to form this reservation. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
}
,
swapProperties:
{
Description: Properties of reservation swap ,
Required: False ,
}
{
swapSource:
{
Description: Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
swapDestination:
{
Description: Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
renew:
{
Description: The renew state of the reservation ,
Required: False ,
}
boolean ,
renewSource:
{
Description: The renew source of the reservation ,
Required: False ,
}
string ,
renewDestination:
{
Description: Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewProperties:
{
Description: The renew properties for a reservation. ,
Required: False ,
}
{
purchaseProperties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. Must be greater than zero. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pricingCurrencyTotal:
{
Description: Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
}
,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: last 7 day utilization trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
productCode:
{
Description: Represents UPN ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Tags for this reservation ,
Required: False ,
}
object ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Description: The name of the reservation sku. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Reservations_ListByBillingProfile (new)
Description :  Lists the reservations for a billing profile and the roll up counts of reservations group by provisioning state.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/reservations
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
skiptoken:
{
Description: The number of reservations to skip from the list before returning results ,
Required: False ,
}
number ,
refreshSummary:
{
Description: To indicate whether to refresh the roll up counts of the reservations group by provisioning states ,
Required: False ,
}
string ,
selectedState:
{
Description: The selected provisioning state ,
Required: False ,
}
string ,
take:
{
Description: The number of reservations to return in API response. ,
Required: False ,
}
number ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
summary:
{
Description: The roll out count summary of the reservations ,
Required: False ,
}
{
cancelledCount:
{
Description: The number of reservation in Cancelled state ,
Required: False ,
}
number ,
expiredCount:
{
Description: The number of reservation in Expired state ,
Required: False ,
}
number ,
expiringCount:
{
Description: The number of reservation in Expiring state ,
Required: False ,
}
number ,
failedCount:
{
Description: The number of reservation in Failed state ,
Required: False ,
}
number ,
pendingCount:
{
Description: The number of reservation in Pending state ,
Required: False ,
}
number ,
succeededCount:
{
Description: The number of reservation in Succeeded state ,
Required: False ,
}
number ,
noBenefitCount:
{
Description: The number of reservation in 'No Benefit' state ,
Required: False ,
}
number ,
warningCount:
{
Description: The number of reservation in Warning state ,
Required: False ,
}
number ,
processingCount:
{
Description: The number of reservation in Processing state ,
Required: False ,
}
number ,
}
,
value:
{
Description: The list of reservations. ,
Required: False ,
}
[
{
location:
{
Description: The location of the reservation. ,
Required: False ,
}
string ,
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the reservation ,
Required: False ,
}
string ,
appliedScopes:
{
Description: The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type of the reservation. ,
Required: False ,
}
string ,
archived:
{
Description: Indicates if the reservation is archived ,
Required: False ,
}
boolean ,
capabilities:
{
Description: Capabilities of the reservation ,
Required: False ,
}
string ,
quantity:
{
Description: The number of the reservation. ,
Required: False ,
}
number ,
provisioningState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
effectiveDateTime:
{
Description: The effective date time of the reservation ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: DateTime of the last time the reservation was updated. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: The expiry date of the reservation ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the reservation ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
{
statusCode:
{
Description: The status of the reservation. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
CapacityError: No description available. ,
CapacityRestricted: No description available. ,
Exchanged: No description available. ,
UnknownError: No description available. ,
RiskCheckFailed: No description available. ,
CreditLineCheckFailed: No description available. ,
Warning: No description available. ,
NoBenefitDueToSubscriptionTransfer: No description available. ,
NoBenefitDueToSubscriptionDeletion: No description available. ,
NoBenefit: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties for extended status information ,
Required: False ,
}
{
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
}
,
}
,
billingPlan:
{
Description: The billing plan options available for this sku. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
purchaseDate:
{
Description: This is the date when the reservation was purchased. ,
Format: date ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: This is the date-time when the reservation was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
splitProperties:
{
Description: Properties of reservation split ,
Required: False ,
}
{
splitDestinations:
{
Description: List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
splitSource:
{
Description: Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
mergeProperties:
{
Description: Properties of reservation merge ,
Required: False ,
}
{
mergeDestination:
{
Description: Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
mergeSources:
{
Description: Resource ids of the source reservation's merged to form this reservation. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
}
,
swapProperties:
{
Description: Properties of reservation swap ,
Required: False ,
}
{
swapSource:
{
Description: Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
swapDestination:
{
Description: Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
renew:
{
Description: The renew state of the reservation ,
Required: False ,
}
boolean ,
renewSource:
{
Description: The renew source of the reservation ,
Required: False ,
}
string ,
renewDestination:
{
Description: Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewProperties:
{
Description: The renew properties for a reservation. ,
Required: False ,
}
{
purchaseProperties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. Must be greater than zero. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pricingCurrencyTotal:
{
Description: Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
}
,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: last 7 day utilization trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
productCode:
{
Description: Represents UPN ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Tags for this reservation ,
Required: False ,
}
object ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Description: The name of the reservation sku. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Reservations_GetByReservationOrder (new)
Description :  Get specific Reservation details in the billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservationOrders/{reservationOrderId}/reservations/{reservationId}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
reservationOrderId:
{
Description: Order Id of the reservation ,
Required: True ,
}
string ,
reservationId:
{
Description: Id of the reservation item ,
Required: True ,
}
string ,
expand:
{
Description: May be used to expand the detail information of some properties. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The location of the reservation. ,
Required: False ,
}
string ,
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the reservation ,
Required: False ,
}
string ,
appliedScopes:
{
Description: The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type of the reservation. ,
Required: False ,
}
string ,
archived:
{
Description: Indicates if the reservation is archived ,
Required: False ,
}
boolean ,
capabilities:
{
Description: Capabilities of the reservation ,
Required: False ,
}
string ,
quantity:
{
Description: The number of the reservation. ,
Required: False ,
}
number ,
provisioningState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
effectiveDateTime:
{
Description: The effective date time of the reservation ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: DateTime of the last time the reservation was updated. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: The expiry date of the reservation ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the reservation ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
{
statusCode:
{
Description: The status of the reservation. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
CapacityError: No description available. ,
CapacityRestricted: No description available. ,
Exchanged: No description available. ,
UnknownError: No description available. ,
RiskCheckFailed: No description available. ,
CreditLineCheckFailed: No description available. ,
Warning: No description available. ,
NoBenefitDueToSubscriptionTransfer: No description available. ,
NoBenefitDueToSubscriptionDeletion: No description available. ,
NoBenefit: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties for extended status information ,
Required: False ,
}
{
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
}
,
}
,
billingPlan:
{
Description: The billing plan options available for this sku. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
purchaseDate:
{
Description: This is the date when the reservation was purchased. ,
Format: date ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: This is the date-time when the reservation was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
splitProperties:
{
Description: Properties of reservation split ,
Required: False ,
}
{
splitDestinations:
{
Description: List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
splitSource:
{
Description: Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
mergeProperties:
{
Description: Properties of reservation merge ,
Required: False ,
}
{
mergeDestination:
{
Description: Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
mergeSources:
{
Description: Resource ids of the source reservation's merged to form this reservation. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
}
,
swapProperties:
{
Description: Properties of reservation swap ,
Required: False ,
}
{
swapSource:
{
Description: Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
swapDestination:
{
Description: Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
renew:
{
Description: The renew state of the reservation ,
Required: False ,
}
boolean ,
renewSource:
{
Description: The renew source of the reservation ,
Required: False ,
}
string ,
renewDestination:
{
Description: Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewProperties:
{
Description: The renew properties for a reservation. ,
Required: False ,
}
{
purchaseProperties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. Must be greater than zero. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pricingCurrencyTotal:
{
Description: Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
}
,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: last 7 day utilization trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
productCode:
{
Description: Represents UPN ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Tags for this reservation ,
Required: False ,
}
object ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Description: The name of the reservation sku. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Reservations_UpdateByBillingAccount (new)
Description :  Update reservation by billing account.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservationOrders/{reservationOrderId}/reservations/{reservationId}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
reservationOrderId:
{
Description: Order Id of the reservation ,
Required: True ,
}
string ,
reservationId:
{
Description: Id of the reservation item ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
body:
{
Description: Request body for patching a reservation ,
Required: True ,
}
{
properties:
{
Description: Properties for reservation patch ,
Required: False ,
}
{
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the reservation ,
Required: False ,
}
string ,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
renewProperties:
{
Required: False ,
}
{
purchaseProperties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. Must be greater than zero. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Description: The name of the reservation sku. ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Tags for this reservation ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
location:
{
Description: The location of the reservation. ,
Required: False ,
}
string ,
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the reservation ,
Required: False ,
}
string ,
appliedScopes:
{
Description: The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type of the reservation. ,
Required: False ,
}
string ,
archived:
{
Description: Indicates if the reservation is archived ,
Required: False ,
}
boolean ,
capabilities:
{
Description: Capabilities of the reservation ,
Required: False ,
}
string ,
quantity:
{
Description: The number of the reservation. ,
Required: False ,
}
number ,
provisioningState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
effectiveDateTime:
{
Description: The effective date time of the reservation ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: DateTime of the last time the reservation was updated. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: The expiry date of the reservation ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the reservation ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
{
statusCode:
{
Description: The status of the reservation. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
CapacityError: No description available. ,
CapacityRestricted: No description available. ,
Exchanged: No description available. ,
UnknownError: No description available. ,
RiskCheckFailed: No description available. ,
CreditLineCheckFailed: No description available. ,
Warning: No description available. ,
NoBenefitDueToSubscriptionTransfer: No description available. ,
NoBenefitDueToSubscriptionDeletion: No description available. ,
NoBenefit: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties for extended status information ,
Required: False ,
}
{
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
}
,
}
,
billingPlan:
{
Description: The billing plan options available for this sku. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
purchaseDate:
{
Description: This is the date when the reservation was purchased. ,
Format: date ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: This is the date-time when the reservation was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
splitProperties:
{
Description: Properties of reservation split ,
Required: False ,
}
{
splitDestinations:
{
Description: List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
splitSource:
{
Description: Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
mergeProperties:
{
Description: Properties of reservation merge ,
Required: False ,
}
{
mergeDestination:
{
Description: Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
mergeSources:
{
Description: Resource ids of the source reservation's merged to form this reservation. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
}
,
swapProperties:
{
Description: Properties of reservation swap ,
Required: False ,
}
{
swapSource:
{
Description: Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
swapDestination:
{
Description: Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
renew:
{
Description: The renew state of the reservation ,
Required: False ,
}
boolean ,
renewSource:
{
Description: The renew source of the reservation ,
Required: False ,
}
string ,
renewDestination:
{
Description: Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewProperties:
{
Description: The renew properties for a reservation. ,
Required: False ,
}
{
purchaseProperties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. Must be greater than zero. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pricingCurrencyTotal:
{
Description: Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
}
,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: last 7 day utilization trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
productCode:
{
Description: Represents UPN ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Tags for this reservation ,
Required: False ,
}
object ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Description: The name of the reservation sku. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
location:
{
Description: URL for determining when an operation has completed. Only use this value only when Azure-AsyncOperation isn't returned. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Reservations_ListByReservationOrder (new)
Description :  List Reservations within a single ReservationOrder in the billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservationOrders/{reservationOrderId}/reservations
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
reservationOrderId:
{
Description: Order Id of the reservation ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
location:
{
Description: The location of the reservation. ,
Required: False ,
}
string ,
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the reservation ,
Required: False ,
}
string ,
appliedScopes:
{
Description: The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type of the reservation. ,
Required: False ,
}
string ,
archived:
{
Description: Indicates if the reservation is archived ,
Required: False ,
}
boolean ,
capabilities:
{
Description: Capabilities of the reservation ,
Required: False ,
}
string ,
quantity:
{
Description: The number of the reservation. ,
Required: False ,
}
number ,
provisioningState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
effectiveDateTime:
{
Description: The effective date time of the reservation ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: DateTime of the last time the reservation was updated. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: The expiry date of the reservation ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the reservation ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
{
statusCode:
{
Description: The status of the reservation. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
CapacityError: No description available. ,
CapacityRestricted: No description available. ,
Exchanged: No description available. ,
UnknownError: No description available. ,
RiskCheckFailed: No description available. ,
CreditLineCheckFailed: No description available. ,
Warning: No description available. ,
NoBenefitDueToSubscriptionTransfer: No description available. ,
NoBenefitDueToSubscriptionDeletion: No description available. ,
NoBenefit: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties for extended status information ,
Required: False ,
}
{
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
}
,
}
,
billingPlan:
{
Description: The billing plan options available for this sku. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
purchaseDate:
{
Description: This is the date when the reservation was purchased. ,
Format: date ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: This is the date-time when the reservation was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
splitProperties:
{
Description: Properties of reservation split ,
Required: False ,
}
{
splitDestinations:
{
Description: List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
splitSource:
{
Description: Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
mergeProperties:
{
Description: Properties of reservation merge ,
Required: False ,
}
{
mergeDestination:
{
Description: Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
mergeSources:
{
Description: Resource ids of the source reservation's merged to form this reservation. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
}
,
swapProperties:
{
Description: Properties of reservation swap ,
Required: False ,
}
{
swapSource:
{
Description: Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
swapDestination:
{
Description: Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
renew:
{
Description: The renew state of the reservation ,
Required: False ,
}
boolean ,
renewSource:
{
Description: The renew source of the reservation ,
Required: False ,
}
string ,
renewDestination:
{
Description: Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewProperties:
{
Description: The renew properties for a reservation. ,
Required: False ,
}
{
purchaseProperties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. Must be greater than zero. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pricingCurrencyTotal:
{
Description: Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
}
,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: last 7 day utilization trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
productCode:
{
Description: Represents UPN ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Tags for this reservation ,
Required: False ,
}
object ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Description: The name of the reservation sku. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Url to get the next page of reservations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReservationOrders_GetByBillingAccount (new)
Description :  Get the details of the ReservationOrder in the billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservationOrders/{reservationOrderId}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
reservationOrderId:
{
Description: Order Id of the reservation ,
Required: True ,
}
string ,
expand:
{
Description: May be used to expand the detail information of some properties. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
properties:
{
Description: The properties associated to this reservation order ,
Required: False ,
}
{
displayName:
{
Description: Friendly name for user to easily identified the reservation order. ,
Required: False ,
}
string ,
enrollmentId:
{
Description: Enrollment id of the reservation order. ,
Required: False ,
}
string ,
customerId:
{
Description: Fully-qualified identifier of the customerId where the benefit is applied. Present only for Enterprise Agreement PartnerLed customers. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing profile Id associated to this reservation order. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: Billing account Id associated to this reservation order. ,
Required: False ,
}
string ,
requestDateTime:
{
Description: This is the DateTime when the reservation order was initially requested for purchase. ,
Format: date-time ,
Required: False ,
}
string ,
createdDateTime:
{
Description: This is the DateTime when the reservation order was created. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: This is the date when the reservation order will expire. ,
Format: date ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation order will expire. ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
originalQuantity:
{
Description: Total original quantity of the skus purchased in the reservation order. ,
Format: int32 ,
Required: False ,
}
integer ,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
planInformation:
{
Description: Information describing the type of billing plan for this reservation order. ,
Required: False ,
}
{
pricingCurrencyTotal:
{
Description: Amount of money to be paid for the Order. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
startDate:
{
Description: Date when the billing plan has started. ,
Format: date ,
Required: False ,
}
string ,
nextPaymentDueDate:
{
Description: For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off. ,
Format: date ,
Required: False ,
}
string ,
transactions:
{
Required: False ,
}
[
{
dueDate:
{
Description: Date when the payment needs to be done. ,
Format: date ,
Required: False ,
}
string ,
paymentDate:
{
Description: Date when the transaction is completed. Is null when it is scheduled. ,
Format: date ,
Required: False ,
}
string ,
pricingCurrencyTotal:
{
Description: Amount in pricing currency. Tax not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Amount charged in Billing currency. Tax not included. Is null for future payments ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingAccount:
{
Description: Shows the Account that is charged for this payment. ,
Required: False ,
}
string ,
status:
{
Description: Describes whether the payment is completed, failed, cancelled or scheduled in the future. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Scheduled: No description available. ,
Cancelled: No description available. ,
Pending: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
extendedStatusInfo:
{
Description: Extended status information for the reservation. ,
Required: False ,
}
{
statusCode:
{
Description: The status of the reservation. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
CapacityError: No description available. ,
CapacityRestricted: No description available. ,
Exchanged: No description available. ,
UnknownError: No description available. ,
RiskCheckFailed: No description available. ,
CreditLineCheckFailed: No description available. ,
Warning: No description available. ,
NoBenefitDueToSubscriptionTransfer: No description available. ,
NoBenefitDueToSubscriptionDeletion: No description available. ,
NoBenefit: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties for extended status information ,
Required: False ,
}
{
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
reservations:
{
Required: False ,
}
[
{
location:
{
Description: The location of the reservation. ,
Required: False ,
}
string ,
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the reservation ,
Required: False ,
}
string ,
appliedScopes:
{
Description: The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type of the reservation. ,
Required: False ,
}
string ,
archived:
{
Description: Indicates if the reservation is archived ,
Required: False ,
}
boolean ,
capabilities:
{
Description: Capabilities of the reservation ,
Required: False ,
}
string ,
quantity:
{
Description: The number of the reservation. ,
Required: False ,
}
number ,
provisioningState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
effectiveDateTime:
{
Description: The effective date time of the reservation ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: DateTime of the last time the reservation was updated. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: The expiry date of the reservation ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the reservation ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
{
statusCode:
{
Description: The status of the reservation. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
CapacityError: No description available. ,
CapacityRestricted: No description available. ,
Exchanged: No description available. ,
UnknownError: No description available. ,
RiskCheckFailed: No description available. ,
CreditLineCheckFailed: No description available. ,
Warning: No description available. ,
NoBenefitDueToSubscriptionTransfer: No description available. ,
NoBenefitDueToSubscriptionDeletion: No description available. ,
NoBenefit: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties for extended status information ,
Required: False ,
}
{
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
}
,
}
,
billingPlan:
{
Description: The billing plan options available for this sku. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
purchaseDate:
{
Description: This is the date when the reservation was purchased. ,
Format: date ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: This is the date-time when the reservation was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
splitProperties:
{
Description: Properties of reservation split ,
Required: False ,
}
{
splitDestinations:
{
Description: List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
splitSource:
{
Description: Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
mergeProperties:
{
Description: Properties of reservation merge ,
Required: False ,
}
{
mergeDestination:
{
Description: Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
mergeSources:
{
Description: Resource ids of the source reservation's merged to form this reservation. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
}
,
swapProperties:
{
Description: Properties of reservation swap ,
Required: False ,
}
{
swapSource:
{
Description: Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
swapDestination:
{
Description: Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
renew:
{
Description: The renew state of the reservation ,
Required: False ,
}
boolean ,
renewSource:
{
Description: The renew source of the reservation ,
Required: False ,
}
string ,
renewDestination:
{
Description: Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewProperties:
{
Description: The renew properties for a reservation. ,
Required: False ,
}
{
purchaseProperties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. Must be greater than zero. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pricingCurrencyTotal:
{
Description: Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
}
,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: last 7 day utilization trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
productCode:
{
Description: Represents UPN ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Tags for this reservation ,
Required: False ,
}
object ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Description: The name of the reservation sku. ,
Required: False ,
}
string ,
}
,
}
,
]
,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: Extended status information for the reservation. ,
Required: False ,
}
{
statusCode:
{
Description: The status of the reservation. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
CapacityError: No description available. ,
CapacityRestricted: No description available. ,
Exchanged: No description available. ,
UnknownError: No description available. ,
RiskCheckFailed: No description available. ,
CreditLineCheckFailed: No description available. ,
Warning: No description available. ,
NoBenefitDueToSubscriptionTransfer: No description available. ,
NoBenefitDueToSubscriptionDeletion: No description available. ,
NoBenefit: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties for extended status information ,
Required: False ,
}
{
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
}
,
}
,
productCode:
{
Description: Represents UPN ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Tags for this reservation ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReservationOrders_ListByBillingAccount (new)
Description :  List all the `ReservationOrders in the billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservationOrders
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
skiptoken:
{
Description: The number of reservations to skip from the list before returning results ,
Required: False ,
}
number ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
properties:
{
Description: The properties associated to this reservation order ,
Required: False ,
}
{
displayName:
{
Description: Friendly name for user to easily identified the reservation order. ,
Required: False ,
}
string ,
enrollmentId:
{
Description: Enrollment id of the reservation order. ,
Required: False ,
}
string ,
customerId:
{
Description: Fully-qualified identifier of the customerId where the benefit is applied. Present only for Enterprise Agreement PartnerLed customers. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing profile Id associated to this reservation order. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: Billing account Id associated to this reservation order. ,
Required: False ,
}
string ,
requestDateTime:
{
Description: This is the DateTime when the reservation order was initially requested for purchase. ,
Format: date-time ,
Required: False ,
}
string ,
createdDateTime:
{
Description: This is the DateTime when the reservation order was created. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: This is the date when the reservation order will expire. ,
Format: date ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation order will expire. ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
originalQuantity:
{
Description: Total original quantity of the skus purchased in the reservation order. ,
Format: int32 ,
Required: False ,
}
integer ,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
planInformation:
{
Description: Information describing the type of billing plan for this reservation order. ,
Required: False ,
}
{
pricingCurrencyTotal:
{
Description: Amount of money to be paid for the Order. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
startDate:
{
Description: Date when the billing plan has started. ,
Format: date ,
Required: False ,
}
string ,
nextPaymentDueDate:
{
Description: For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off. ,
Format: date ,
Required: False ,
}
string ,
transactions:
{
Required: False ,
}
[
{
dueDate:
{
Description: Date when the payment needs to be done. ,
Format: date ,
Required: False ,
}
string ,
paymentDate:
{
Description: Date when the transaction is completed. Is null when it is scheduled. ,
Format: date ,
Required: False ,
}
string ,
pricingCurrencyTotal:
{
Description: Amount in pricing currency. Tax not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Amount charged in Billing currency. Tax not included. Is null for future payments ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingAccount:
{
Description: Shows the Account that is charged for this payment. ,
Required: False ,
}
string ,
status:
{
Description: Describes whether the payment is completed, failed, cancelled or scheduled in the future. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Scheduled: No description available. ,
Cancelled: No description available. ,
Pending: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
extendedStatusInfo:
{
Description: Extended status information for the reservation. ,
Required: False ,
}
{
statusCode:
{
Description: The status of the reservation. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
CapacityError: No description available. ,
CapacityRestricted: No description available. ,
Exchanged: No description available. ,
UnknownError: No description available. ,
RiskCheckFailed: No description available. ,
CreditLineCheckFailed: No description available. ,
Warning: No description available. ,
NoBenefitDueToSubscriptionTransfer: No description available. ,
NoBenefitDueToSubscriptionDeletion: No description available. ,
NoBenefit: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties for extended status information ,
Required: False ,
}
{
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
reservations:
{
Required: False ,
}
[
{
location:
{
Description: The location of the reservation. ,
Required: False ,
}
string ,
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the reservation ,
Required: False ,
}
string ,
appliedScopes:
{
Description: The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type of the reservation. ,
Required: False ,
}
string ,
archived:
{
Description: Indicates if the reservation is archived ,
Required: False ,
}
boolean ,
capabilities:
{
Description: Capabilities of the reservation ,
Required: False ,
}
string ,
quantity:
{
Description: The number of the reservation. ,
Required: False ,
}
number ,
provisioningState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
effectiveDateTime:
{
Description: The effective date time of the reservation ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: DateTime of the last time the reservation was updated. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: The expiry date of the reservation ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the reservation ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
{
statusCode:
{
Description: The status of the reservation. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
CapacityError: No description available. ,
CapacityRestricted: No description available. ,
Exchanged: No description available. ,
UnknownError: No description available. ,
RiskCheckFailed: No description available. ,
CreditLineCheckFailed: No description available. ,
Warning: No description available. ,
NoBenefitDueToSubscriptionTransfer: No description available. ,
NoBenefitDueToSubscriptionDeletion: No description available. ,
NoBenefit: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties for extended status information ,
Required: False ,
}
{
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
}
,
}
,
billingPlan:
{
Description: The billing plan options available for this sku. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
purchaseDate:
{
Description: This is the date when the reservation was purchased. ,
Format: date ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: This is the date-time when the reservation was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
splitProperties:
{
Description: Properties of reservation split ,
Required: False ,
}
{
splitDestinations:
{
Description: List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
splitSource:
{
Description: Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
mergeProperties:
{
Description: Properties of reservation merge ,
Required: False ,
}
{
mergeDestination:
{
Description: Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
mergeSources:
{
Description: Resource ids of the source reservation's merged to form this reservation. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
}
,
swapProperties:
{
Description: Properties of reservation swap ,
Required: False ,
}
{
swapSource:
{
Description: Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
swapDestination:
{
Description: Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
renew:
{
Description: The renew state of the reservation ,
Required: False ,
}
boolean ,
renewSource:
{
Description: The renew source of the reservation ,
Required: False ,
}
string ,
renewDestination:
{
Description: Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewProperties:
{
Description: The renew properties for a reservation. ,
Required: False ,
}
{
purchaseProperties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. Must be greater than zero. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pricingCurrencyTotal:
{
Description: Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
}
,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: last 7 day utilization trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
productCode:
{
Description: Represents UPN ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Tags for this reservation ,
Required: False ,
}
object ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Description: The name of the reservation sku. ,
Required: False ,
}
string ,
}
,
}
,
]
,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: Extended status information for the reservation. ,
Required: False ,
}
{
statusCode:
{
Description: The status of the reservation. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
CapacityError: No description available. ,
CapacityRestricted: No description available. ,
Exchanged: No description available. ,
UnknownError: No description available. ,
RiskCheckFailed: No description available. ,
CreditLineCheckFailed: No description available. ,
Warning: No description available. ,
NoBenefitDueToSubscriptionTransfer: No description available. ,
NoBenefitDueToSubscriptionDeletion: No description available. ,
NoBenefit: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties for extended status information ,
Required: False ,
}
{
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
}
,
}
,
productCode:
{
Description: Represents UPN ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Tags for this reservation ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Url to get the next page of reservationOrders. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/transactions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Format: date ,
Required: True ,
}
string ,
periodEndDate:
{
Description: The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Format: date ,
Required: True ,
}
string ,
type:
{
Description: The type of transaction. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A transaction. ,
Required: False ,
}
{
azureCreditApplied:
{
Description: The amount of any Azure credits automatically applied to this transaction. ,
Required: False ,
}
string ,
azurePlan:
{
Description: Details of the Azure plan. ,
Required: False ,
}
string ,
billingCurrency:
{
Description: The ISO 4217 code for the currency in which this transaction is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCommitmentDecremented:
{
Description: The amount of Microsoft Azure Consumption Commitment(MACC) decrement through the transaction. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
creditType:
{
Description: The credit type of the transaction. Applies only to credited transactions. ,
Enum:
{
Other: No description available. ,
AzureFreeCredit: No description available. ,
AzureCreditOffer: No description available. ,
ServiceInterruption: No description available. ,
Refund: No description available. ,
}
,
Required: False ,
}
enum ,
date:
{
Description: The date of transaction. ,
Format: date-time ,
Required: False ,
}
string ,
discount:
{
Description: The percentage discount, if any, applied to this transaction. ,
Required: False ,
}
number ,
effectivePrice:
{
Description: The price of the product after applying any discounts. ,
Required: False ,
}
string ,
exchangeRate:
{
Description: The exchange rate used to convert charged amount to billing currency, if applicable. ,
Required: False ,
}
number ,
invoice:
{
Description: Invoice name on which the transaction was billed or 'Pending' if the transaction is not billed. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The fully qualified ID of the invoice on which the transaction was billed. This field is only applicable for transactions which are billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
isThirdParty:
{
Description: Whether or not the transaction is third party. ,
Required: False ,
}
boolean ,
kind:
{
Description: Type of the transaction, billed or unbilled. ,
Enum:
{
Other: No description available. ,
All: No description available. ,
Reservation: No description available. ,
}
,
Required: False ,
}
enum ,
marketPrice:
{
Description: The retail price of the product. ,
Required: False ,
}
string ,
partNumber:
{
Description: The part number of the product for which the transaction took place. The field is only applicable for Enterprise Agreement invoices. ,
Required: False ,
}
string ,
pricingCurrency:
{
Description: The ISO 4217 code for the currency in which the product is priced. ,
Required: False ,
}
string ,
productDescription:
{
Description: The description of the product for which the transaction took place. ,
Required: False ,
}
string ,
productFamily:
{
Description: The family of the product for which the transaction took place. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product type for which the transaction took place. ,
Required: False ,
}
string ,
productType:
{
Description: The type of the product for which the transaction took place. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased in the transaction. ,
Format: int32 ,
Required: False ,
}
integer ,
reasonCode:
{
Description: There reason code for the transaction. ,
Required: False ,
}
string ,
servicePeriodStartDate:
{
Description: The date of the purchase of the product, or the start date of the month in which usage started. ,
Format: date-time ,
Required: False ,
}
string ,
servicePeriodEndDate:
{
Description: The end date of the product term, or the end date of the month in which usage ended. ,
Format: date-time ,
Required: False ,
}
string ,
subTotal:
{
Description: The pre-tax charged amount for the transaction. ,
Required: False ,
}
string ,
tax:
{
Description: The tax amount applied to the transaction. ,
Required: False ,
}
string ,
transactionAmount:
{
Description: The charge associated with the transaction. ,
Required: False ,
}
string ,
transactionType:
{
Description: The type of transaction. ,
Required: False ,
}
string ,
units:
{
Description: The number of units used for a given product. ,
Required: False ,
}
number ,
unitOfMeasure:
{
Description: The unit of measure used to bill for the product. For example, compute services are billed per hour. ,
Required: False ,
}
string ,
unitType:
{
Description: The description for the unit of measure for a given product. ,
Required: False ,
}
string ,
specialTaxationType:
{
Description: Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic. ,
Enum:
{
SubtotalLevel: No description available. ,
InvoiceLevel: No description available. ,
}
,
Required: False ,
}
enum ,
refundTransactionDetails:
{
Description: The refund details of a transaction. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/transactions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Format: date ,
Required: True ,
}
string ,
periodEndDate:
{
Description: The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Format: date ,
Required: True ,
}
string ,
type:
{
Description: The type of transaction. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A transaction. ,
Required: False ,
}
{
azureCreditApplied:
{
Description: The amount of any Azure credits automatically applied to this transaction. ,
Required: False ,
}
string ,
azurePlan:
{
Description: Details of the Azure plan. ,
Required: False ,
}
string ,
billingCurrency:
{
Description: The ISO 4217 code for the currency in which this transaction is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCommitmentDecremented:
{
Description: The amount of Microsoft Azure Consumption Commitment(MACC) decrement through the transaction. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
creditType:
{
Description: The credit type of the transaction. Applies only to credited transactions. ,
Enum:
{
Other: No description available. ,
AzureFreeCredit: No description available. ,
AzureCreditOffer: No description available. ,
ServiceInterruption: No description available. ,
Refund: No description available. ,
}
,
Required: False ,
}
enum ,
date:
{
Description: The date of transaction. ,
Format: date-time ,
Required: False ,
}
string ,
discount:
{
Description: The percentage discount, if any, applied to this transaction. ,
Required: False ,
}
number ,
effectivePrice:
{
Description: The price of the product after applying any discounts. ,
Required: False ,
}
string ,
exchangeRate:
{
Description: The exchange rate used to convert charged amount to billing currency, if applicable. ,
Required: False ,
}
number ,
invoice:
{
Description: Invoice name on which the transaction was billed or 'Pending' if the transaction is not billed. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The fully qualified ID of the invoice on which the transaction was billed. This field is only applicable for transactions which are billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
isThirdParty:
{
Description: Whether or not the transaction is third party. ,
Required: False ,
}
boolean ,
kind:
{
Description: Type of the transaction, billed or unbilled. ,
Enum:
{
Other: No description available. ,
All: No description available. ,
Reservation: No description available. ,
}
,
Required: False ,
}
enum ,
marketPrice:
{
Description: The retail price of the product. ,
Required: False ,
}
string ,
partNumber:
{
Description: The part number of the product for which the transaction took place. The field is only applicable for Enterprise Agreement invoices. ,
Required: False ,
}
string ,
pricingCurrency:
{
Description: The ISO 4217 code for the currency in which the product is priced. ,
Required: False ,
}
string ,
productDescription:
{
Description: The description of the product for which the transaction took place. ,
Required: False ,
}
string ,
productFamily:
{
Description: The family of the product for which the transaction took place. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product type for which the transaction took place. ,
Required: False ,
}
string ,
productType:
{
Description: The type of the product for which the transaction took place. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased in the transaction. ,
Format: int32 ,
Required: False ,
}
integer ,
reasonCode:
{
Description: There reason code for the transaction. ,
Required: False ,
}
string ,
servicePeriodStartDate:
{
Description: The date of the purchase of the product, or the start date of the month in which usage started. ,
Format: date-time ,
Required: False ,
}
string ,
servicePeriodEndDate:
{
Description: The end date of the product term, or the end date of the month in which usage ended. ,
Format: date-time ,
Required: False ,
}
string ,
subTotal:
{
Description: The pre-tax charged amount for the transaction. ,
Required: False ,
}
string ,
tax:
{
Description: The tax amount applied to the transaction. ,
Required: False ,
}
string ,
transactionAmount:
{
Description: The charge associated with the transaction. ,
Required: False ,
}
string ,
transactionType:
{
Description: The type of transaction. ,
Required: False ,
}
string ,
units:
{
Description: The number of units used for a given product. ,
Required: False ,
}
number ,
unitOfMeasure:
{
Description: The unit of measure used to bill for the product. For example, compute services are billed per hour. ,
Required: False ,
}
string ,
unitType:
{
Description: The description for the unit of measure for a given product. ,
Required: False ,
}
string ,
specialTaxationType:
{
Description: Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic. ,
Enum:
{
SubtotalLevel: No description available. ,
InvoiceLevel: No description available. ,
}
,
Required: False ,
}
enum ,
refundTransactionDetails:
{
Description: The refund details of a transaction. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/transactions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Format: date ,
Required: True ,
}
string ,
periodEndDate:
{
Description: The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Format: date ,
Required: True ,
}
string ,
type:
{
Description: The type of transaction. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A transaction. ,
Required: False ,
}
{
azureCreditApplied:
{
Description: The amount of any Azure credits automatically applied to this transaction. ,
Required: False ,
}
string ,
azurePlan:
{
Description: Details of the Azure plan. ,
Required: False ,
}
string ,
billingCurrency:
{
Description: The ISO 4217 code for the currency in which this transaction is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCommitmentDecremented:
{
Description: The amount of Microsoft Azure Consumption Commitment(MACC) decrement through the transaction. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
creditType:
{
Description: The credit type of the transaction. Applies only to credited transactions. ,
Enum:
{
Other: No description available. ,
AzureFreeCredit: No description available. ,
AzureCreditOffer: No description available. ,
ServiceInterruption: No description available. ,
Refund: No description available. ,
}
,
Required: False ,
}
enum ,
date:
{
Description: The date of transaction. ,
Format: date-time ,
Required: False ,
}
string ,
discount:
{
Description: The percentage discount, if any, applied to this transaction. ,
Required: False ,
}
number ,
effectivePrice:
{
Description: The price of the product after applying any discounts. ,
Required: False ,
}
string ,
exchangeRate:
{
Description: The exchange rate used to convert charged amount to billing currency, if applicable. ,
Required: False ,
}
number ,
invoice:
{
Description: Invoice name on which the transaction was billed or 'Pending' if the transaction is not billed. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The fully qualified ID of the invoice on which the transaction was billed. This field is only applicable for transactions which are billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
isThirdParty:
{
Description: Whether or not the transaction is third party. ,
Required: False ,
}
boolean ,
kind:
{
Description: Type of the transaction, billed or unbilled. ,
Enum:
{
Other: No description available. ,
All: No description available. ,
Reservation: No description available. ,
}
,
Required: False ,
}
enum ,
marketPrice:
{
Description: The retail price of the product. ,
Required: False ,
}
string ,
partNumber:
{
Description: The part number of the product for which the transaction took place. The field is only applicable for Enterprise Agreement invoices. ,
Required: False ,
}
string ,
pricingCurrency:
{
Description: The ISO 4217 code for the currency in which the product is priced. ,
Required: False ,
}
string ,
productDescription:
{
Description: The description of the product for which the transaction took place. ,
Required: False ,
}
string ,
productFamily:
{
Description: The family of the product for which the transaction took place. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product type for which the transaction took place. ,
Required: False ,
}
string ,
productType:
{
Description: The type of the product for which the transaction took place. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased in the transaction. ,
Format: int32 ,
Required: False ,
}
integer ,
reasonCode:
{
Description: There reason code for the transaction. ,
Required: False ,
}
string ,
servicePeriodStartDate:
{
Description: The date of the purchase of the product, or the start date of the month in which usage started. ,
Format: date-time ,
Required: False ,
}
string ,
servicePeriodEndDate:
{
Description: The end date of the product term, or the end date of the month in which usage ended. ,
Format: date-time ,
Required: False ,
}
string ,
subTotal:
{
Description: The pre-tax charged amount for the transaction. ,
Required: False ,
}
string ,
tax:
{
Description: The tax amount applied to the transaction. ,
Required: False ,
}
string ,
transactionAmount:
{
Description: The charge associated with the transaction. ,
Required: False ,
}
string ,
transactionType:
{
Description: The type of transaction. ,
Required: False ,
}
string ,
units:
{
Description: The number of units used for a given product. ,
Required: False ,
}
number ,
unitOfMeasure:
{
Description: The unit of measure used to bill for the product. For example, compute services are billed per hour. ,
Required: False ,
}
string ,
unitType:
{
Description: The description for the unit of measure for a given product. ,
Required: False ,
}
string ,
specialTaxationType:
{
Description: Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic. ,
Enum:
{
SubtotalLevel: No description available. ,
InvoiceLevel: No description available. ,
}
,
Required: False ,
}
enum ,
refundTransactionDetails:
{
Description: The refund details of a transaction. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Transactions_ListByInvoice (new)
Description :  Lists the transactions for an invoice. Transactions include purchases, refunds and Azure usage charges.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/transactions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
invoiceName:
{
Description: The ID that uniquely identifies an invoice. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A transaction. ,
Required: False ,
}
{
azureCreditApplied:
{
Description: The amount of any Azure credits automatically applied to this transaction. ,
Required: False ,
}
string ,
azurePlan:
{
Description: Details of the Azure plan. ,
Required: False ,
}
string ,
billingCurrency:
{
Description: The ISO 4217 code for the currency in which this transaction is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCommitmentDecremented:
{
Description: The amount of Microsoft Azure Consumption Commitment(MACC) decrement through the transaction. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
creditType:
{
Description: The credit type of the transaction. Applies only to credited transactions. ,
Enum:
{
Other: No description available. ,
AzureFreeCredit: No description available. ,
AzureCreditOffer: No description available. ,
ServiceInterruption: No description available. ,
Refund: No description available. ,
}
,
Required: False ,
}
enum ,
date:
{
Description: The date of transaction. ,
Format: date-time ,
Required: False ,
}
string ,
discount:
{
Description: The percentage discount, if any, applied to this transaction. ,
Required: False ,
}
number ,
effectivePrice:
{
Description: The price of the product after applying any discounts. ,
Required: False ,
}
string ,
exchangeRate:
{
Description: The exchange rate used to convert charged amount to billing currency, if applicable. ,
Required: False ,
}
number ,
invoice:
{
Description: Invoice name on which the transaction was billed or 'Pending' if the transaction is not billed. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The fully qualified ID of the invoice on which the transaction was billed. This field is only applicable for transactions which are billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
isThirdParty:
{
Description: Whether or not the transaction is third party. ,
Required: False ,
}
boolean ,
kind:
{
Description: Type of the transaction, billed or unbilled. ,
Enum:
{
Other: No description available. ,
All: No description available. ,
Reservation: No description available. ,
}
,
Required: False ,
}
enum ,
marketPrice:
{
Description: The retail price of the product. ,
Required: False ,
}
string ,
partNumber:
{
Description: The part number of the product for which the transaction took place. The field is only applicable for Enterprise Agreement invoices. ,
Required: False ,
}
string ,
pricingCurrency:
{
Description: The ISO 4217 code for the currency in which the product is priced. ,
Required: False ,
}
string ,
productDescription:
{
Description: The description of the product for which the transaction took place. ,
Required: False ,
}
string ,
productFamily:
{
Description: The family of the product for which the transaction took place. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product type for which the transaction took place. ,
Required: False ,
}
string ,
productType:
{
Description: The type of the product for which the transaction took place. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased in the transaction. ,
Format: int32 ,
Required: False ,
}
integer ,
reasonCode:
{
Description: There reason code for the transaction. ,
Required: False ,
}
string ,
servicePeriodStartDate:
{
Description: The date of the purchase of the product, or the start date of the month in which usage started. ,
Format: date-time ,
Required: False ,
}
string ,
servicePeriodEndDate:
{
Description: The end date of the product term, or the end date of the month in which usage ended. ,
Format: date-time ,
Required: False ,
}
string ,
subTotal:
{
Description: The pre-tax charged amount for the transaction. ,
Required: False ,
}
string ,
tax:
{
Description: The tax amount applied to the transaction. ,
Required: False ,
}
string ,
transactionAmount:
{
Description: The charge associated with the transaction. ,
Required: False ,
}
string ,
transactionType:
{
Description: The type of transaction. ,
Required: False ,
}
string ,
units:
{
Description: The number of units used for a given product. ,
Required: False ,
}
number ,
unitOfMeasure:
{
Description: The unit of measure used to bill for the product. For example, compute services are billed per hour. ,
Required: False ,
}
string ,
unitType:
{
Description: The description for the unit of measure for a given product. ,
Required: False ,
}
string ,
specialTaxationType:
{
Description: Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic. ,
Enum:
{
SubtotalLevel: No description available. ,
InvoiceLevel: No description available. ,
}
,
Required: False ,
}
enum ,
refundTransactionDetails:
{
Description: The refund details of a transaction. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Transactions_TransactionsDownloadByInvoice (new)
Description :  Gets a URL to download the transactions document for an invoice. The operation is supported for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Transactions_GetTransactionSummaryByInvoice (new)
Description :  Gets the transaction summary for an invoice. Transactions include purchases, refunds and Azure usage charges.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/transactionSummary
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
invoiceName:
{
Description: The ID that uniquely identifies an invoice. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter the line items that are aggregated to create the line item summary. ,
Required: False ,
}
string ,
search:
{
Description: The search query option allows clients to filter the line items that are aggregated to create the line item summary. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
azureCreditApplied:
{
Description: The total amount of any Azure credits applied. ,
Required: False ,
}
number ,
billingCurrency:
{
Description: The ISO 4217 code for the currency in which the transactions are billed. ,
Required: False ,
}
string ,
consumptionCommitmentDecremented:
{
Description: The total Microsoft Azure Consumption Commitment (MACC) decrement through the invoice. ,
Required: False ,
}
number ,
subTotal:
{
Description: The total pre-tax charged amount. ,
Required: False ,
}
number ,
tax:
{
Description: The total tax amount applied. ,
Required: False ,
}
number ,
total:
{
Description: The total charges. ,
Required: False ,
}
number ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Transfers_Get (new)
Description :  Gets a transfer request by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Expired: No description available. ,
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
Department: No description available. ,
SavingsPlan: No description available. ,
SAAS: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
productName:
{
Description: The name of the product that is transferred. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

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

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/transfers/{transferName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the initiate transfer operation. ,
Required: True ,
}
{
properties:
{
Description: Request parameters to initiate transfer. ,
Required: False ,
}
{
recipientEmailId:
{
Description: The email ID of the recipient to whom the transfer request is sent. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Expired: No description available. ,
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
Department: No description available. ,
SavingsPlan: No description available. ,
SAAS: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
productName:
{
Description: The name of the product that is transferred. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Expired: No description available. ,
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
Department: No description available. ,
SavingsPlan: No description available. ,
SAAS: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
productName:
{
Description: The name of the product that is transferred. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Transfers_Cancel (new)
Description :  Cancels a transfer request. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Expired: No description available. ,
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
Department: No description available. ,
SavingsPlan: No description available. ,
SAAS: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
productName:
{
Description: The name of the product that is transferred. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of transfers initiated by caller. ,
Required: False ,
}
[
{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Expired: No description available. ,
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
Department: No description available. ,
SavingsPlan: No description available. ,
SAAS: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
productName:
{
Description: The name of the product that is transferred. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
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 error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PartnerTransfers_Get (new)
Description :  Gets a transfer request by ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/transfers/{transferName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/transfers/{transferName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the initiate transfer operation. ,
Required: True ,
}
{
properties:
{
Description: Request parameters to initiate partner transfer. ,
Required: False ,
}
{
recipientEmailId:
{
Description: The email ID of the recipient to whom the transfer request is sent. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PartnerTransfers_Cancel (new)
Description :  Cancels a transfer request. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/transfers/{transferName}/cancel
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of transfers initiated by partner. ,
Required: False ,
}
[
{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Expired: No description available. ,
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorCustomerType:
{
Description: The type of customer who sent the transfer request. ,
Enum:
{
Partner: No description available. ,
EA: No description available. ,
}
,
Required: False ,
}
enum ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
resellerName:
{
Description: Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
Department: No description available. ,
SavingsPlan: No description available. ,
SAAS: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
productName:
{
Description: The name of the product that is transferred. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
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 error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecipientTransfers_Accept (new)
Description :  Accepts a transfer request.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/transfers/{transferName}/accept
{
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the accept transfer operation. ,
Required: True ,
}
{
properties:
{
Description: Request parameters to accept transfer. ,
Required: False ,
}
{
productDetails:
{
Description: Request parameters to accept transfer. ,
Required: False ,
}
[
{
productType:
{
Description: Type of the product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
Department: No description available. ,
SavingsPlan: No description available. ,
SAAS: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecipientTransfers_Validate (new)
Description :  Validates if a subscription or a reservation can be transferred. Use this operation to validate your subscriptions or reservation before using the accept transfer operation.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/transfers/{transferName}/validate
{
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the validate transfer operation. ,
Required: True ,
}
{
properties:
{
Description: Request parameters to accept transfer. ,
Required: False ,
}
{
productDetails:
{
Description: Request parameters to accept transfer. ,
Required: False ,
}
[
{
productType:
{
Description: Type of the product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
Department: No description available. ,
SavingsPlan: No description available. ,
SAAS: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecipientTransfers_Decline (new)
Description :  Declines a transfer request.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/transfers/{transferName}/decline
{
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecipientTransfers_Get (new)
Description :  Gets a transfer request by ID. The caller must be the recipient of the transfer request.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/transfers/{transferName}
{
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecipientTransfers_List (new)
Description :  Lists the transfer requests received by the caller.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Agreements_Get (removed)
Description :  Gets an agreement by ID.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: An agreement. ,
Required: False ,
}
{
acceptanceMode:
{
Description: The mode of acceptance for an agreement. ,
Enum:
{
Other: No description available. ,
ClickToAccept: No description available. ,
ESignEmbedded: No description available. ,
ESignOffline: No description available. ,
Implicit: No description available. ,
Offline: No description available. ,
PhysicalSign: No description available. ,
}
,
Required: False ,
}
enum ,
agreementLink:
{
Description: The URL to download the agreement. ,
Required: False ,
}
string ,
billingProfileInfo:
{
Description: The list of billing profiles associated with agreement and present only for specific agreements. ,
Required: False ,
}
[
{
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The friendly ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileSystemId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
indirectRelationshipOrganizationName:
{
Description: Billing account name. Available for a specific type of agreement. ,
Required: False ,
}
string ,
}
,
]
,
category:
{
Description: The category of the agreement. ,
Enum:
{
Other: No description available. ,
AffiliatePurchaseTerms: No description available. ,
IndirectForGovernmentAgreement: No description available. ,
MicrosoftCustomerAgreement: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
UKCloudComputeFramework: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The name of the agreement signed by a customer. ,
Required: False ,
}
string ,
effectiveDate:
{
Description: The date from which the agreement is effective. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date when the agreement expires. ,
Format: date-time ,
Required: False ,
}
string ,
participants:
{
Description: The list of participants that participates in acceptance of an agreement. ,
Required: False ,
}
[
{
email:
{
Description: The email address of the participant. ,
Required: False ,
}
string ,
status:
{
Description: The acceptance status of the participant. ,
Required: False ,
}
string ,
statusDate:
{
Description: The date when the status got changed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The current status of the agreement. ,
Required: False ,
}
string ,
leadBillingAccountName:
{
Description: The ID of the lead billing account if this agreement is part of the Customer Affiliate Purchase Terms. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Agreements_ListByBillingAccount (removed)
Description :  Lists the agreements for a billing account.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: An agreement. ,
Required: False ,
}
{
acceptanceMode:
{
Description: The mode of acceptance for an agreement. ,
Enum:
{
Other: No description available. ,
ClickToAccept: No description available. ,
ESignEmbedded: No description available. ,
ESignOffline: No description available. ,
Implicit: No description available. ,
Offline: No description available. ,
PhysicalSign: No description available. ,
}
,
Required: False ,
}
enum ,
agreementLink:
{
Description: The URL to download the agreement. ,
Required: False ,
}
string ,
billingProfileInfo:
{
Description: The list of billing profiles associated with agreement and present only for specific agreements. ,
Required: False ,
}
[
{
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The friendly ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileSystemId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
indirectRelationshipOrganizationName:
{
Description: Billing account name. Available for a specific type of agreement. ,
Required: False ,
}
string ,
}
,
]
,
category:
{
Description: The category of the agreement. ,
Enum:
{
Other: No description available. ,
AffiliatePurchaseTerms: No description available. ,
IndirectForGovernmentAgreement: No description available. ,
MicrosoftCustomerAgreement: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
UKCloudComputeFramework: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The name of the agreement signed by a customer. ,
Required: False ,
}
string ,
effectiveDate:
{
Description: The date from which the agreement is effective. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date when the agreement expires. ,
Format: date-time ,
Required: False ,
}
string ,
participants:
{
Description: The list of participants that participates in acceptance of an agreement. ,
Required: False ,
}
[
{
email:
{
Description: The email address of the participant. ,
Required: False ,
}
string ,
status:
{
Description: The acceptance status of the participant. ,
Required: False ,
}
string ,
statusDate:
{
Description: The date when the status got changed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The current status of the agreement. ,
Required: False ,
}
string ,
leadBillingAccountName:
{
Description: The ID of the lead billing account if this agreement is part of the Customer Affiliate Purchase Terms. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssociatedTenants_Delete (removed)
Description :  Deletes an associated tenant for a billing account.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/associatedTenants/{associatedTenantName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
associatedTenantName:
{
Description: The ID that uniquely identifies a tenant. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssociatedTenants_Get (removed)
Description :  Gets an associated tenant by ID.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: An associated tenant. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The name of the associated tenant. ,
Required: False ,
}
string ,
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
billingManagementState:
{
Description: The state determines whether users from the associated tenant can be assigned roles for commerce activities like viewing and downloading invoices, managing payments, and making purchases. ,
Enum:
{
Other: No description available. ,
NotAllowed: No description available. ,
Active: No description available. ,
Revoked: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningManagementState:
{
Description: The state determines whether subscriptions and licenses can be provisioned in the associated tenant. It can be set to 'Pending' to initiate a billing request. ,
Enum:
{
Other: No description available. ,
NotRequested: No description available. ,
Active: No description available. ,
Pending: No description available. ,
BillingRequestExpired: No description available. ,
BillingRequestDeclined: No description available. ,
Revoked: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningBillingRequestId:
{
Description: The unique identifier for the billing request that is created when enabling provisioning for an associated tenant. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssociatedTenants_CreateOrUpdate (removed)
Description :  Create or update an associated tenant for the billing account.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/associatedTenants/{associatedTenantName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
associatedTenantName:
{
Description: The ID that uniquely identifies a tenant. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: An associated tenant. ,
Required: True ,
}
{
properties:
{
Description: An associated tenant. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The name of the associated tenant. ,
Required: False ,
}
string ,
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
billingManagementState:
{
Description: The state determines whether users from the associated tenant can be assigned roles for commerce activities like viewing and downloading invoices, managing payments, and making purchases. ,
Enum:
{
Other: No description available. ,
NotAllowed: No description available. ,
Active: No description available. ,
Revoked: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningManagementState:
{
Description: The state determines whether subscriptions and licenses can be provisioned in the associated tenant. It can be set to 'Pending' to initiate a billing request. ,
Enum:
{
Other: No description available. ,
NotRequested: No description available. ,
Active: No description available. ,
Pending: No description available. ,
BillingRequestExpired: No description available. ,
BillingRequestDeclined: No description available. ,
Revoked: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningBillingRequestId:
{
Description: The unique identifier for the billing request that is created when enabling provisioning for an associated tenant. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: An associated tenant. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The name of the associated tenant. ,
Required: False ,
}
string ,
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
billingManagementState:
{
Description: The state determines whether users from the associated tenant can be assigned roles for commerce activities like viewing and downloading invoices, managing payments, and making purchases. ,
Enum:
{
Other: No description available. ,
NotAllowed: No description available. ,
Active: No description available. ,
Revoked: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningManagementState:
{
Description: The state determines whether subscriptions and licenses can be provisioned in the associated tenant. It can be set to 'Pending' to initiate a billing request. ,
Enum:
{
Other: No description available. ,
NotRequested: No description available. ,
Active: No description available. ,
Pending: No description available. ,
BillingRequestExpired: No description available. ,
BillingRequestDeclined: No description available. ,
Revoked: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningBillingRequestId:
{
Description: The unique identifier for the billing request that is created when enabling provisioning for an associated tenant. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location: string ,
retry-after: integer ,
}
,
$schema:
{
Description: An associated tenant. ,
}
{
properties:
{
Description: An associated tenant. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The name of the associated tenant. ,
Required: False ,
}
string ,
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
billingManagementState:
{
Description: The state determines whether users from the associated tenant can be assigned roles for commerce activities like viewing and downloading invoices, managing payments, and making purchases. ,
Enum:
{
Other: No description available. ,
NotAllowed: No description available. ,
Active: No description available. ,
Revoked: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningManagementState:
{
Description: The state determines whether subscriptions and licenses can be provisioned in the associated tenant. It can be set to 'Pending' to initiate a billing request. ,
Enum:
{
Other: No description available. ,
NotRequested: No description available. ,
Active: No description available. ,
Pending: No description available. ,
BillingRequestExpired: No description available. ,
BillingRequestDeclined: No description available. ,
Revoked: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningBillingRequestId:
{
Description: The unique identifier for the billing request that is created when enabling provisioning for an associated tenant. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssociatedTenants_ListByBillingAccount (removed)
Description :  Lists the associated tenants that can collaborate with the billing account on commerce activities like viewing and downloading invoices, managing payments, making purchases, and managing or provisioning licenses.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/associatedTenants
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
includeRevoked:
{
Description: Can be used to get revoked associated tenants. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: An associated tenant. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The name of the associated tenant. ,
Required: False ,
}
string ,
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
billingManagementState:
{
Description: The state determines whether users from the associated tenant can be assigned roles for commerce activities like viewing and downloading invoices, managing payments, and making purchases. ,
Enum:
{
Other: No description available. ,
NotAllowed: No description available. ,
Active: No description available. ,
Revoked: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningManagementState:
{
Description: The state determines whether subscriptions and licenses can be provisioned in the associated tenant. It can be set to 'Pending' to initiate a billing request. ,
Enum:
{
Other: No description available. ,
NotRequested: No description available. ,
Active: No description available. ,
Pending: No description available. ,
BillingRequestExpired: No description available. ,
BillingRequestDeclined: No description available. ,
Revoked: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningBillingRequestId:
{
Description: The unique identifier for the billing request that is created when enabling provisioning for an associated tenant. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AvailableBalances_GetByBillingAccount (removed)
Description :  The Available Credit or Payment on Account Balance for a billing account. The credit balance can be used to settle due or past due invoices and is supported for billing accounts with agreement type Microsoft Customer Agreement. The payment on account balance is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Online Services Program.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The Available Credit or Payment on Account Balance. The credit balance can be used to settle due or past due invoices. ,
Required: False ,
}
{
amount:
{
Description: Credit amount for immediate payment. ,
Required: False ,
}
string ,
paymentsOnAccount:
{
Description: The list of payments on accounts. ,
Required: False ,
}
[
{
amount:
{
Description: Payment on Account amount. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile for the payments on account. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for the payments on account. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The ID of the invoice for which the payments on account was generated. ,
Required: False ,
}
string ,
invoiceName:
{
Description: The name of the invoice for the payments on account. ,
Required: False ,
}
string ,
date:
{
Description: The date of the payments on account. ,
Format: date-time ,
Required: False ,
}
string ,
paymentMethodType:
{
Description: Payment on Account type. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
totalPaymentsOnAccount:
{
Description: Total amount of payments on accounts. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AvailableBalances_GetByBillingProfile (removed)
Description :  The Available Credit or Payment on Account Balance for a billing profile. The credit balance can be used to settle due or past due invoices and is supported for billing accounts with agreement type Microsoft Customer Agreement. The payment on account balance is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The Available Credit or Payment on Account Balance. The credit balance can be used to settle due or past due invoices. ,
Required: False ,
}
{
amount:
{
Description: Credit amount for immediate payment. ,
Required: False ,
}
string ,
paymentsOnAccount:
{
Description: The list of payments on accounts. ,
Required: False ,
}
[
{
amount:
{
Description: Payment on Account amount. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile for the payments on account. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for the payments on account. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The ID of the invoice for which the payments on account was generated. ,
Required: False ,
}
string ,
invoiceName:
{
Description: The name of the invoice for the payments on account. ,
Required: False ,
}
string ,
date:
{
Description: The date of the payments on account. ,
Format: date-time ,
Required: False ,
}
string ,
paymentMethodType:
{
Description: Payment on Account type. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
totalPaymentsOnAccount:
{
Description: Total amount of payments on accounts. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingAccounts_AddPaymentTerms (removed)
Description :  Adds payment terms to all the billing profiles under the billing account. Currently, payment terms can be added only on billing accounts that have Agreement Type as 'Microsoft Customer Agreement' and AccountType as 'Enterprise'. This action needs pre-authorization and only Field Sellers are authorized to add the payment terms and is not a self-serve action.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/addPaymentTerms
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of payment term. ,
Required: True ,
}
{
term:
{
Description: Represents duration in netXX format. Always in days. ,
Required: False ,
}
string ,
startDate:
{
Description: The date on when the defined 'Payment Term' will be effective from and is always in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date on when the defined 'Payment Term' will end and is always in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
isDefault:
{
Description: Indicates payment term is the standard payment term. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A billing account. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatus:
{
Description: The current status of the billing account. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
UnderReview: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Extended: No description available. ,
Pending: No description available. ,
New: No description available. ,
Expired: No description available. ,
Terminated: No description available. ,
Transferred: No description available. ,
}
,
Required: False ,
}
enum ,
accountType:
{
Description: The type of customer. ,
Enum:
{
Other: No description available. ,
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
Reseller: No description available. ,
ClassicPartner: No description available. ,
Internal: No description available. ,
Tenant: No description available. ,
Business: No description available. ,
}
,
Required: False ,
}
enum ,
accountSubType:
{
Description: The tier of the account. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Individual: No description available. ,
Professional: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatusReasonCode:
{
Description: Reason for the specified billing account status. ,
Enum:
{
Other: No description available. ,
UnusualActivity: No description available. ,
ManuallyTerminated: No description available. ,
Expired: No description available. ,
Transferred: No description available. ,
TerminateProcessing: No description available. ,
}
,
Required: False ,
}
enum ,
agreementType:
{
Description: The type of agreement. ,
Enum:
{
Other: No description available. ,
MicrosoftCustomerAgreement: No description available. ,
EnterpriseAgreement: No description available. ,
MicrosoftOnlineServicesProgram: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
enrollmentDetails:
{
Description: The properties of an enrollment. ,
Required: False ,
}
string ,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing account. ,
Required: False ,
}
boolean ,
hasNoBillingProfiles:
{
Description: Indicates whether or not the billing account has any billing profiles. ,
Required: False ,
}
boolean ,
notificationEmailAddress:
{
Description: Notification email address for legacy account. Available for agreement type Microsoft Online Services Program. ,
Required: False ,
}
string ,
primaryBillingTenantId:
{
Description: The tenant that was used to set up the billing account. By default, only users from this tenant can get role assignments on the billing account and all purchases are provisioned in this tenant. ,
Required: False ,
}
string ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
string ,
registrationNumber:
{
Description: Describes the registration number of the organization linked with the billing account. ,
Required: False ,
}
string ,
billingRelationshipTypes:
{
Description: Identifies the billing relationships represented by a billing account. The billing relationship may be between Microsoft, the customer, and/or a third-party. ,
Required: False ,
}
[
string ,
]
,
qualifications:
{
Description: Qualifications for pricing on a billing account. Values may be Commercial, Education, Charity or Government. ,
Required: False ,
}
[
string ,
]
,
taxIds:
{
Description: A list of tax identifiers for the billing account. ,
Required: False ,
}
[
{
id:
{
Description: The id of the tax identifier. ,
Required: False ,
}
string ,
type:
{
Description: The type of the tax identifier. ,
Enum:
{
Other: No description available. ,
BrazilCcmId: No description available. ,
BrazilCnpjId: No description available. ,
BrazilCpfId: No description available. ,
CanadianFederalExempt: No description available. ,
CanadianProvinceExempt: No description available. ,
ExternalTaxation: No description available. ,
IndiaFederalTanId: No description available. ,
IndiaFederalServiceTaxId: No description available. ,
IndiaPanId: No description available. ,
IndiaStateCstId: No description available. ,
IndiaStateGstINId: No description available. ,
IndiaStateVatId: No description available. ,
IntlExempt: No description available. ,
USExempt: No description available. ,
VatId: No description available. ,
LoveCode: No description available. ,
MobileBarCode: No description available. ,
NationalIdentificationNumber: No description available. ,
PublicSectorId: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope of the tax identifier. ,
Required: False ,
}
string ,
country:
{
Description: The country of the tax identifier. ,
Required: False ,
}
string ,
status:
{
Description: The status of the tax identifier. ,
Enum:
{
Other: No description available. ,
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingAccounts_CancelPaymentTerms (removed)
Description :  Cancels all the payment terms on billing account that falls after the cancellation date in the request. Currently, cancel payment terms is only served by admin actions and is not a self-serve action.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/cancelPaymentTerms
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Date after which any payment terms that needs to be cancelled. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A billing account. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatus:
{
Description: The current status of the billing account. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
UnderReview: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Extended: No description available. ,
Pending: No description available. ,
New: No description available. ,
Expired: No description available. ,
Terminated: No description available. ,
Transferred: No description available. ,
}
,
Required: False ,
}
enum ,
accountType:
{
Description: The type of customer. ,
Enum:
{
Other: No description available. ,
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
Reseller: No description available. ,
ClassicPartner: No description available. ,
Internal: No description available. ,
Tenant: No description available. ,
Business: No description available. ,
}
,
Required: False ,
}
enum ,
accountSubType:
{
Description: The tier of the account. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Individual: No description available. ,
Professional: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatusReasonCode:
{
Description: Reason for the specified billing account status. ,
Enum:
{
Other: No description available. ,
UnusualActivity: No description available. ,
ManuallyTerminated: No description available. ,
Expired: No description available. ,
Transferred: No description available. ,
TerminateProcessing: No description available. ,
}
,
Required: False ,
}
enum ,
agreementType:
{
Description: The type of agreement. ,
Enum:
{
Other: No description available. ,
MicrosoftCustomerAgreement: No description available. ,
EnterpriseAgreement: No description available. ,
MicrosoftOnlineServicesProgram: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
enrollmentDetails:
{
Description: The properties of an enrollment. ,
Required: False ,
}
string ,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing account. ,
Required: False ,
}
boolean ,
hasNoBillingProfiles:
{
Description: Indicates whether or not the billing account has any billing profiles. ,
Required: False ,
}
boolean ,
notificationEmailAddress:
{
Description: Notification email address for legacy account. Available for agreement type Microsoft Online Services Program. ,
Required: False ,
}
string ,
primaryBillingTenantId:
{
Description: The tenant that was used to set up the billing account. By default, only users from this tenant can get role assignments on the billing account and all purchases are provisioned in this tenant. ,
Required: False ,
}
string ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
string ,
registrationNumber:
{
Description: Describes the registration number of the organization linked with the billing account. ,
Required: False ,
}
string ,
billingRelationshipTypes:
{
Description: Identifies the billing relationships represented by a billing account. The billing relationship may be between Microsoft, the customer, and/or a third-party. ,
Required: False ,
}
[
string ,
]
,
qualifications:
{
Description: Qualifications for pricing on a billing account. Values may be Commercial, Education, Charity or Government. ,
Required: False ,
}
[
string ,
]
,
taxIds:
{
Description: A list of tax identifiers for the billing account. ,
Required: False ,
}
[
{
id:
{
Description: The id of the tax identifier. ,
Required: False ,
}
string ,
type:
{
Description: The type of the tax identifier. ,
Enum:
{
Other: No description available. ,
BrazilCcmId: No description available. ,
BrazilCnpjId: No description available. ,
BrazilCpfId: No description available. ,
CanadianFederalExempt: No description available. ,
CanadianProvinceExempt: No description available. ,
ExternalTaxation: No description available. ,
IndiaFederalTanId: No description available. ,
IndiaFederalServiceTaxId: No description available. ,
IndiaPanId: No description available. ,
IndiaStateCstId: No description available. ,
IndiaStateGstINId: No description available. ,
IndiaStateVatId: No description available. ,
IntlExempt: No description available. ,
USExempt: No description available. ,
VatId: No description available. ,
LoveCode: No description available. ,
MobileBarCode: No description available. ,
NationalIdentificationNumber: No description available. ,
PublicSectorId: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope of the tax identifier. ,
Required: False ,
}
string ,
country:
{
Description: The country of the tax identifier. ,
Required: False ,
}
string ,
status:
{
Description: The status of the tax identifier. ,
Enum:
{
Other: No description available. ,
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingAccounts_ConfirmTransition (removed)
Description :  Gets the transition details for a billing account that has transitioned from agreement type Microsoft Online Services Program to agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
transitionDate:
{
Description: The transition completion date. ,
Format: date-time ,
Required: False ,
}
string ,
anniversaryDay:
{
Description: The anniversary day of the pre-transitioned account of type Microsoft Online Services Program. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingAccounts_ListInvoiceSectionsByCreateSubscriptionPermission (removed)
Description :  Lists the invoice sections for which the user has permission to create Azure subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/listInvoiceSectionsWithCreateSubscriptionPermission
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileSystemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
billingProfileStatus:
{
Description: The status of the billing profile. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfileStatusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfileSpendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
enabledAzurePlans:
{
Description: Enabled azure plans for the associated billing profile. ,
Required: False ,
}
[
{
productId:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
skuId:
{
Description: The ID that uniquely identifies a sku. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionSystemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingAccounts_ValidatePaymentTerms (removed)
Description :  Validates payment terms on a billing account with agreement type 'Microsoft Customer Agreement' and account type 'Enterprise'.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/validatePaymentTerms
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of payment term. ,
Required: True ,
}
{
term:
{
Description: Represents duration in netXX format. Always in days. ,
Required: False ,
}
string ,
startDate:
{
Description: The date on when the defined 'Payment Term' will be effective from and is always in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date on when the defined 'Payment Term' will end and is always in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
isDefault:
{
Description: Indicates payment term is the standard payment term. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
eligibilityStatus:
{
Description: Indicates the eligibility status of the payment terms. ,
Enum:
{
Other: No description available. ,
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
eligibilityDetails:
{
Description: Details of the payment terms eligibility. ,
Required: False ,
}
[
{
code:
{
Description: Indicates the reason for the ineligibility of the payment terms. ,
Enum:
{
Other: No description available. ,
OverlappingPaymentTerms: No description available. ,
InvalidDateFormat: No description available. ,
InvalidDateRange: No description available. ,
InactiveBillingAccount: No description available. ,
InvalidBillingAccountType: No description available. ,
NullOrEmptyPaymentTerms: No description available. ,
BillingAccountNotFound: No description available. ,
IneligibleBillingAccountStatus: No description available. ,
InvalidTerms: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Indicates the message for the ineligibility of the payment terms. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingAccounts_Get (removed)
Description :  Gets a billing account by its ID.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: A billing account. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatus:
{
Description: The current status of the billing account. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
UnderReview: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Extended: No description available. ,
Pending: No description available. ,
New: No description available. ,
Expired: No description available. ,
Terminated: No description available. ,
Transferred: No description available. ,
}
,
Required: False ,
}
enum ,
accountType:
{
Description: The type of customer. ,
Enum:
{
Other: No description available. ,
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
Reseller: No description available. ,
ClassicPartner: No description available. ,
Internal: No description available. ,
Tenant: No description available. ,
Business: No description available. ,
}
,
Required: False ,
}
enum ,
accountSubType:
{
Description: The tier of the account. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Individual: No description available. ,
Professional: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatusReasonCode:
{
Description: Reason for the specified billing account status. ,
Enum:
{
Other: No description available. ,
UnusualActivity: No description available. ,
ManuallyTerminated: No description available. ,
Expired: No description available. ,
Transferred: No description available. ,
TerminateProcessing: No description available. ,
}
,
Required: False ,
}
enum ,
agreementType:
{
Description: The type of agreement. ,
Enum:
{
Other: No description available. ,
MicrosoftCustomerAgreement: No description available. ,
EnterpriseAgreement: No description available. ,
MicrosoftOnlineServicesProgram: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
enrollmentDetails:
{
Description: The properties of an enrollment. ,
Required: False ,
}
string ,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing account. ,
Required: False ,
}
boolean ,
hasNoBillingProfiles:
{
Description: Indicates whether or not the billing account has any billing profiles. ,
Required: False ,
}
boolean ,
notificationEmailAddress:
{
Description: Notification email address for legacy account. Available for agreement type Microsoft Online Services Program. ,
Required: False ,
}
string ,
primaryBillingTenantId:
{
Description: The tenant that was used to set up the billing account. By default, only users from this tenant can get role assignments on the billing account and all purchases are provisioned in this tenant. ,
Required: False ,
}
string ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
string ,
registrationNumber:
{
Description: Describes the registration number of the organization linked with the billing account. ,
Required: False ,
}
string ,
billingRelationshipTypes:
{
Description: Identifies the billing relationships represented by a billing account. The billing relationship may be between Microsoft, the customer, and/or a third-party. ,
Required: False ,
}
[
string ,
]
,
qualifications:
{
Description: Qualifications for pricing on a billing account. Values may be Commercial, Education, Charity or Government. ,
Required: False ,
}
[
string ,
]
,
taxIds:
{
Description: A list of tax identifiers for the billing account. ,
Required: False ,
}
[
{
id:
{
Description: The id of the tax identifier. ,
Required: False ,
}
string ,
type:
{
Description: The type of the tax identifier. ,
Enum:
{
Other: No description available. ,
BrazilCcmId: No description available. ,
BrazilCnpjId: No description available. ,
BrazilCpfId: No description available. ,
CanadianFederalExempt: No description available. ,
CanadianProvinceExempt: No description available. ,
ExternalTaxation: No description available. ,
IndiaFederalTanId: No description available. ,
IndiaFederalServiceTaxId: No description available. ,
IndiaPanId: No description available. ,
IndiaStateCstId: No description available. ,
IndiaStateGstINId: No description available. ,
IndiaStateVatId: No description available. ,
IntlExempt: No description available. ,
USExempt: No description available. ,
VatId: No description available. ,
LoveCode: No description available. ,
MobileBarCode: No description available. ,
NationalIdentificationNumber: No description available. ,
PublicSectorId: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope of the tax identifier. ,
Required: False ,
}
string ,
country:
{
Description: The country of the tax identifier. ,
Required: False ,
}
string ,
status:
{
Description: The status of the tax identifier. ,
Enum:
{
Other: No description available. ,
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingAccounts_Update (removed)
Description :  Updates the properties of a billing account. Currently, displayName and address can be updated for billing accounts with agreement type Microsoft Customer Agreement. Currently address and notification email address can be updated for billing accounts with agreement type Microsoft Online Services Agreement. Currently, purchase order number can be edited for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: A billing account. ,
Required: True ,
}
{
properties:
{
Description: A billing account. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatus:
{
Description: The current status of the billing account. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
UnderReview: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Extended: No description available. ,
Pending: No description available. ,
New: No description available. ,
Expired: No description available. ,
Terminated: No description available. ,
Transferred: No description available. ,
}
,
Required: False ,
}
enum ,
accountType:
{
Description: The type of customer. ,
Enum:
{
Other: No description available. ,
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
Reseller: No description available. ,
ClassicPartner: No description available. ,
Internal: No description available. ,
Tenant: No description available. ,
Business: No description available. ,
}
,
Required: False ,
}
enum ,
accountSubType:
{
Description: The tier of the account. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Individual: No description available. ,
Professional: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatusReasonCode:
{
Description: Reason for the specified billing account status. ,
Enum:
{
Other: No description available. ,
UnusualActivity: No description available. ,
ManuallyTerminated: No description available. ,
Expired: No description available. ,
Transferred: No description available. ,
TerminateProcessing: No description available. ,
}
,
Required: False ,
}
enum ,
agreementType:
{
Description: The type of agreement. ,
Enum:
{
Other: No description available. ,
MicrosoftCustomerAgreement: No description available. ,
EnterpriseAgreement: No description available. ,
MicrosoftOnlineServicesProgram: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
enrollmentDetails:
{
Description: The properties of an enrollment. ,
Required: False ,
}
string ,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing account. ,
Required: False ,
}
boolean ,
hasNoBillingProfiles:
{
Description: Indicates whether or not the billing account has any billing profiles. ,
Required: False ,
}
boolean ,
notificationEmailAddress:
{
Description: Notification email address for legacy account. Available for agreement type Microsoft Online Services Program. ,
Required: False ,
}
string ,
primaryBillingTenantId:
{
Description: The tenant that was used to set up the billing account. By default, only users from this tenant can get role assignments on the billing account and all purchases are provisioned in this tenant. ,
Required: False ,
}
string ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
string ,
registrationNumber:
{
Description: Describes the registration number of the organization linked with the billing account. ,
Required: False ,
}
string ,
billingRelationshipTypes:
{
Description: Identifies the billing relationships represented by a billing account. The billing relationship may be between Microsoft, the customer, and/or a third-party. ,
Required: False ,
}
[
string ,
]
,
qualifications:
{
Description: Qualifications for pricing on a billing account. Values may be Commercial, Education, Charity or Government. ,
Required: False ,
}
[
string ,
]
,
taxIds:
{
Description: A list of tax identifiers for the billing account. ,
Required: False ,
}
[
{
id:
{
Description: The id of the tax identifier. ,
Required: False ,
}
string ,
type:
{
Description: The type of the tax identifier. ,
Enum:
{
Other: No description available. ,
BrazilCcmId: No description available. ,
BrazilCnpjId: No description available. ,
BrazilCpfId: No description available. ,
CanadianFederalExempt: No description available. ,
CanadianProvinceExempt: No description available. ,
ExternalTaxation: No description available. ,
IndiaFederalTanId: No description available. ,
IndiaFederalServiceTaxId: No description available. ,
IndiaPanId: No description available. ,
IndiaStateCstId: No description available. ,
IndiaStateGstINId: No description available. ,
IndiaStateVatId: No description available. ,
IntlExempt: No description available. ,
USExempt: No description available. ,
VatId: No description available. ,
LoveCode: No description available. ,
MobileBarCode: No description available. ,
NationalIdentificationNumber: No description available. ,
PublicSectorId: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope of the tax identifier. ,
Required: False ,
}
string ,
country:
{
Description: The country of the tax identifier. ,
Required: False ,
}
string ,
status:
{
Description: The status of the tax identifier. ,
Enum:
{
Other: No description available. ,
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A billing account. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatus:
{
Description: The current status of the billing account. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
UnderReview: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Extended: No description available. ,
Pending: No description available. ,
New: No description available. ,
Expired: No description available. ,
Terminated: No description available. ,
Transferred: No description available. ,
}
,
Required: False ,
}
enum ,
accountType:
{
Description: The type of customer. ,
Enum:
{
Other: No description available. ,
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
Reseller: No description available. ,
ClassicPartner: No description available. ,
Internal: No description available. ,
Tenant: No description available. ,
Business: No description available. ,
}
,
Required: False ,
}
enum ,
accountSubType:
{
Description: The tier of the account. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Individual: No description available. ,
Professional: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatusReasonCode:
{
Description: Reason for the specified billing account status. ,
Enum:
{
Other: No description available. ,
UnusualActivity: No description available. ,
ManuallyTerminated: No description available. ,
Expired: No description available. ,
Transferred: No description available. ,
TerminateProcessing: No description available. ,
}
,
Required: False ,
}
enum ,
agreementType:
{
Description: The type of agreement. ,
Enum:
{
Other: No description available. ,
MicrosoftCustomerAgreement: No description available. ,
EnterpriseAgreement: No description available. ,
MicrosoftOnlineServicesProgram: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
enrollmentDetails:
{
Description: The properties of an enrollment. ,
Required: False ,
}
string ,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing account. ,
Required: False ,
}
boolean ,
hasNoBillingProfiles:
{
Description: Indicates whether or not the billing account has any billing profiles. ,
Required: False ,
}
boolean ,
notificationEmailAddress:
{
Description: Notification email address for legacy account. Available for agreement type Microsoft Online Services Program. ,
Required: False ,
}
string ,
primaryBillingTenantId:
{
Description: The tenant that was used to set up the billing account. By default, only users from this tenant can get role assignments on the billing account and all purchases are provisioned in this tenant. ,
Required: False ,
}
string ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
string ,
registrationNumber:
{
Description: Describes the registration number of the organization linked with the billing account. ,
Required: False ,
}
string ,
billingRelationshipTypes:
{
Description: Identifies the billing relationships represented by a billing account. The billing relationship may be between Microsoft, the customer, and/or a third-party. ,
Required: False ,
}
[
string ,
]
,
qualifications:
{
Description: Qualifications for pricing on a billing account. Values may be Commercial, Education, Charity or Government. ,
Required: False ,
}
[
string ,
]
,
taxIds:
{
Description: A list of tax identifiers for the billing account. ,
Required: False ,
}
[
{
id:
{
Description: The id of the tax identifier. ,
Required: False ,
}
string ,
type:
{
Description: The type of the tax identifier. ,
Enum:
{
Other: No description available. ,
BrazilCcmId: No description available. ,
BrazilCnpjId: No description available. ,
BrazilCpfId: No description available. ,
CanadianFederalExempt: No description available. ,
CanadianProvinceExempt: No description available. ,
ExternalTaxation: No description available. ,
IndiaFederalTanId: No description available. ,
IndiaFederalServiceTaxId: No description available. ,
IndiaPanId: No description available. ,
IndiaStateCstId: No description available. ,
IndiaStateGstINId: No description available. ,
IndiaStateVatId: No description available. ,
IntlExempt: No description available. ,
USExempt: No description available. ,
VatId: No description available. ,
LoveCode: No description available. ,
MobileBarCode: No description available. ,
NationalIdentificationNumber: No description available. ,
PublicSectorId: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope of the tax identifier. ,
Required: False ,
}
string ,
country:
{
Description: The country of the tax identifier. ,
Required: False ,
}
string ,
status:
{
Description: The status of the tax identifier. ,
Enum:
{
Other: No description available. ,
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingAccounts_List (removed)
Description :  Lists the billing accounts that a user has access to.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts
{
includeAll:
{
Description: When true, results will include Billing Accounts that the user does not have a direct role assignment on if the user has one of the following AAD roles: Global Administrator, Global Reader, Billing Administrator. ,
Required: False ,
}
boolean ,
includeAllWithoutBillingProfiles:
{
Description: When true, results will include Billing Accounts that are not fully created if the user has one of the following AAD roles: Global Administrator, Global Reader, Billing Administrator. ,
Required: False ,
}
boolean ,
includeDeleted:
{
Description: When true, results will include any billing accounts in a deleted state. ,
Required: False ,
}
boolean ,
includePendingAgreement:
{
Description: Includes billing accounts with agreement pending signature that the user has access to. ,
Required: False ,
}
boolean ,
includeResellee:
{
Description: Includes the customer's billing account of Microsoft Partner Agreement that the user has access to. ,
Required: False ,
}
boolean ,
legalOwnerTID:
{
Description: Must be combined with legalOwnerOID, results will only include Billing Accounts for whom is legally responsible for the Billing Accounts. Optional. ,
Required: False ,
}
string ,
legalOwnerOID:
{
Description: Must be combined with legalOwnerTID, results will only include Billing Accounts for whom is legally responsible for the Billing Accounts. Optional. ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
expand:
{
Description: Expand is allowed for SoldTo and EnrollmentDetails/PONumber. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A billing account. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatus:
{
Description: The current status of the billing account. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
UnderReview: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Extended: No description available. ,
Pending: No description available. ,
New: No description available. ,
Expired: No description available. ,
Terminated: No description available. ,
Transferred: No description available. ,
}
,
Required: False ,
}
enum ,
accountType:
{
Description: The type of customer. ,
Enum:
{
Other: No description available. ,
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
Reseller: No description available. ,
ClassicPartner: No description available. ,
Internal: No description available. ,
Tenant: No description available. ,
Business: No description available. ,
}
,
Required: False ,
}
enum ,
accountSubType:
{
Description: The tier of the account. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Individual: No description available. ,
Professional: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatusReasonCode:
{
Description: Reason for the specified billing account status. ,
Enum:
{
Other: No description available. ,
UnusualActivity: No description available. ,
ManuallyTerminated: No description available. ,
Expired: No description available. ,
Transferred: No description available. ,
TerminateProcessing: No description available. ,
}
,
Required: False ,
}
enum ,
agreementType:
{
Description: The type of agreement. ,
Enum:
{
Other: No description available. ,
MicrosoftCustomerAgreement: No description available. ,
EnterpriseAgreement: No description available. ,
MicrosoftOnlineServicesProgram: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
enrollmentDetails:
{
Description: The properties of an enrollment. ,
Required: False ,
}
string ,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing account. ,
Required: False ,
}
boolean ,
hasNoBillingProfiles:
{
Description: Indicates whether or not the billing account has any billing profiles. ,
Required: False ,
}
boolean ,
notificationEmailAddress:
{
Description: Notification email address for legacy account. Available for agreement type Microsoft Online Services Program. ,
Required: False ,
}
string ,
primaryBillingTenantId:
{
Description: The tenant that was used to set up the billing account. By default, only users from this tenant can get role assignments on the billing account and all purchases are provisioned in this tenant. ,
Required: False ,
}
string ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
string ,
registrationNumber:
{
Description: Describes the registration number of the organization linked with the billing account. ,
Required: False ,
}
string ,
billingRelationshipTypes:
{
Description: Identifies the billing relationships represented by a billing account. The billing relationship may be between Microsoft, the customer, and/or a third-party. ,
Required: False ,
}
[
string ,
]
,
qualifications:
{
Description: Qualifications for pricing on a billing account. Values may be Commercial, Education, Charity or Government. ,
Required: False ,
}
[
string ,
]
,
taxIds:
{
Description: A list of tax identifiers for the billing account. ,
Required: False ,
}
[
{
id:
{
Description: The id of the tax identifier. ,
Required: False ,
}
string ,
type:
{
Description: The type of the tax identifier. ,
Enum:
{
Other: No description available. ,
BrazilCcmId: No description available. ,
BrazilCnpjId: No description available. ,
BrazilCpfId: No description available. ,
CanadianFederalExempt: No description available. ,
CanadianProvinceExempt: No description available. ,
ExternalTaxation: No description available. ,
IndiaFederalTanId: No description available. ,
IndiaFederalServiceTaxId: No description available. ,
IndiaPanId: No description available. ,
IndiaStateCstId: No description available. ,
IndiaStateGstINId: No description available. ,
IndiaStateVatId: No description available. ,
IntlExempt: No description available. ,
USExempt: No description available. ,
VatId: No description available. ,
LoveCode: No description available. ,
MobileBarCode: No description available. ,
NationalIdentificationNumber: No description available. ,
PublicSectorId: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope of the tax identifier. ,
Required: False ,
}
string ,
country:
{
Description: The country of the tax identifier. ,
Required: False ,
}
string ,
status:
{
Description: The status of the tax identifier. ,
Enum:
{
Other: No description available. ,
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Address_Validate (removed)
Description :  Validates an address. Use the operation to validate an address before using it as soldTo or a billTo address.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/validateAddress
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Address details. ,
Required: True ,
}
{
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. Optional for MCA Individual (Pay-as-you-go). ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO 3166-1 Alpha-2 format. ,
Required: True ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
firstName:
{
Description: First name. Optional for MCA Enterprise. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. Optional for MCA Enterprise. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
isValidAddress:
{
Description: Indicates if the address is incomplete. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
status:
{
Description: Status of the address validation. ,
Enum:
{
Other: No description available. ,
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
suggestedAddresses:
{
Description: The list of suggested addresses. ,
Required: False ,
}
[
{
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. Optional for MCA Individual (Pay-as-you-go). ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO 3166-1 Alpha-2 format. ,
Required: True ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
firstName:
{
Description: First name. Optional for MCA Enterprise. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. Optional for MCA Enterprise. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
isValidAddress:
{
Description: Indicates if the address is incomplete. ,
Required: False ,
}
boolean ,
}
,
]
,
validationMessage:
{
Description: Validation error message. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingPermissions_ListByBillingAccount (removed)
Description :  Lists the billing permissions the caller has on a billing account.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingPermissions_ListByBillingProfile (removed)
Description :  Lists the billing permissions the caller has on a billing profile.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingPermissions_CheckAccessByBillingProfile (removed)
Description :  Provides a list of check access response objects for a billing profile.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/checkAccess
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The request object against which access of the caller will be checked. ,
Required: True ,
}
{
actions:
{
Description: List of actions passed in the request body against which the permissions will be checked. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
accessDecision:
{
Description: Access Decision, specifies access is allowed or not. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Gets or sets an action. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingPermissions_ListByCustomer (removed)
Description :  Lists the billing permissions the caller has for a customer.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingPermissions_CheckAccessByCustomer (removed)
Description :  Provides a list of check access response objects for a customer.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/checkAccess
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The request object against which access of the caller will be checked. ,
Required: True ,
}
{
actions:
{
Description: List of actions passed in the request body against which the permissions will be checked. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
accessDecision:
{
Description: Access Decision, specifies access is allowed or not. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Gets or sets an action. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingPermissions_ListByInvoiceSection (removed)
Description :  Lists the billing permissions the caller has for an invoice section.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingPermissions_CheckAccessByInvoiceSection (removed)
Description :  Provides a list of check access response objects for an invoice section.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/checkAccess
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The request object against which access of the caller will be checked. ,
Required: True ,
}
{
actions:
{
Description: List of actions passed in the request body against which the permissions will be checked. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
accessDecision:
{
Description: Access Decision, specifies access is allowed or not. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Gets or sets an action. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingPermissions_CheckAccessByBillingAccount (removed)
Description :  Provides a list of check access response objects for a billing account.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/checkAccess
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The request object against which access of the caller will be checked. ,
Required: True ,
}
{
actions:
{
Description: List of actions passed in the request body against which the permissions will be checked. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
accessDecision:
{
Description: Access Decision, specifies access is allowed or not. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Gets or sets an action. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingPermissions_ListByCustomerAtBillingAccount (removed)
Description :  Lists the billing permissions the caller has for a customer at billing account level.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingPermissions_ListByDepartment (removed)
Description :  Lists the billing permissions the caller has for a department.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingPermissions_CheckAccessByDepartment (removed)
Description :  Provides a list of check access response objects for a department.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/checkAccess
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
departmentName:
{
Description: The name of the department. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The request object against which access of the caller will be checked. ,
Required: True ,
}
{
actions:
{
Description: List of actions passed in the request body against which the permissions will be checked. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
accessDecision:
{
Description: Access Decision, specifies access is allowed or not. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Gets or sets an action. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingPermissions_ListByEnrollmentAccount (removed)
Description :  Lists the billing permissions the caller has for an enrollment account.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingPermissions_CheckAccessByEnrollmentAccount (removed)
Description :  Provides a list of check access response objects for an enrollment account.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/checkAccess
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
enrollmentAccountName:
{
Description: The name of the enrollment account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The request object against which access of the caller will be checked. ,
Required: True ,
}
{
actions:
{
Description: List of actions passed in the request body against which the permissions will be checked. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
accessDecision:
{
Description: Access Decision, specifies access is allowed or not. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Gets or sets an action. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingProfiles_ValidateDeleteEligibility (removed)
Description :  Validates if the billing profile can be deleted. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
eligibilityStatus:
{
Description: Status describing if billing profile is eligible to be deleted. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
eligibilityDetails:
{
Description: Validation details of delete billing profile eligibility. ,
Required: False ,
}
[
{
code:
{
Description: Code of the delete invoice section eligibility response. ,
Enum:
{
None: No description available. ,
ActiveCredits: No description available. ,
ActiveCreditCard: No description available. ,
LastBillingProfile: No description available. ,
NotSupported: No description available. ,
OutstandingCharges: No description available. ,
PendingCharges: No description available. ,
ReservedInstances: No description available. ,
ActiveBillingSubscriptions: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingProfiles_Delete (removed)
Description :  Deletes a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingProfiles_Get (removed)
Description :  Gets a billing profile by its ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
billingRelationshipType:
{
Description: Identifies the billing relationship represented by the billing profile. The billing relationship may be between Microsoft, the customer, and/or a third-party. ,
Enum:
{
Other: No description available. ,
Direct: No description available. ,
IndirectCustomer: No description available. ,
IndirectPartner: No description available. ,
CSPPartner: No description available. ,
CSPCustomer: No description available. ,
}
,
Required: False ,
}
enum ,
billTo:
{
Description: Billing address. ,
Required: False ,
}
string ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Information about the enabled azure plans. ,
Required: False ,
}
[
{
productId:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
skuId:
{
Description: The ID that uniquely identifies a sku. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing profile. ,
Required: False ,
}
boolean ,
indirectRelationshipInfo:
{
Description: Identifies the billing profile that is linked to another billing profile in indirect purchase motion. ,
Required: False ,
}
string ,
invoiceDay:
{
Description: The day of the month when the invoice for the billing profile is generated. ,
Format: int32 ,
Required: False ,
}
integer ,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
invoiceRecipients:
{
Description: The list of email addresses to receive invoices by email for the billing profile. ,
Required: False ,
}
[
string ,
]
,
poNumber:
{
Description: The default purchase order number that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
shipTo:
{
Description: The default address where the products are shipped, or the services are being used. If a ship to is not specified for a product or a subscription, then this address will be used. ,
Required: False ,
}
string ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
string ,
spendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
spendingLimitDetails:
{
Description: The details of billing profile spending limit. ,
Required: False ,
}
[
{
amount:
{
Description: The initial amount for the billing profile. ,
Required: False ,
}
number ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
startDate:
{
Description: The date when this spending limit goes into effect. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date when this spending limit is no longer in effect. ,
Format: date-time ,
Required: False ,
}
string ,
type:
{
Description: The type of spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
FreeAccount: No description available. ,
Sandbox: No description available. ,
AzureForStudents: No description available. ,
AcademicSponsorship: No description available. ,
AzureConsumptionCredit: No description available. ,
AzurePassSponsorship: No description available. ,
MpnSponsorship: No description available. ,
MSDN: No description available. ,
NonProfitSponsorship: No description available. ,
Sponsorship: No description available. ,
StartupSponsorship: No description available. ,
AzureForStudentsStarter: No description available. ,
VisualStudio: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of current spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Active: No description available. ,
Expired: No description available. ,
LimitReached: No description available. ,
LimitRemoved: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
status:
{
Description: The status of the billing profile. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
statusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
targetClouds:
{
Description: Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. ,
Required: False ,
}
[
string ,
]
,
currentPaymentTerm:
{
Description: The current payment term of the billing profile. ,
Required: False ,
}
string ,
otherPaymentTerms:
{
Description: The other payment terms of the billing profile. ,
Required: False ,
}
[
{
term:
{
Description: Represents duration in netXX format. Always in days. ,
Required: False ,
}
string ,
startDate:
{
Description: The date on when the defined 'Payment Term' will be effective from and is always in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date on when the defined 'Payment Term' will end and is always in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
isDefault:
{
Description: Indicates payment term is the standard payment term. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingProfiles_CreateOrUpdate (removed)
Description :  Creates or updates a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. If you are a MCA Individual (Pay-as-you-go) customer, then please use the Azure portal experience to create the billing profile.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: A billing profile. ,
Required: True ,
}
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
billingRelationshipType:
{
Description: Identifies the billing relationship represented by the billing profile. The billing relationship may be between Microsoft, the customer, and/or a third-party. ,
Enum:
{
Other: No description available. ,
Direct: No description available. ,
IndirectCustomer: No description available. ,
IndirectPartner: No description available. ,
CSPPartner: No description available. ,
CSPCustomer: No description available. ,
}
,
Required: False ,
}
enum ,
billTo:
{
Description: Billing address. ,
Required: False ,
}
string ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Information about the enabled azure plans. ,
Required: False ,
}
[
{
productId:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
skuId:
{
Description: The ID that uniquely identifies a sku. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing profile. ,
Required: False ,
}
boolean ,
indirectRelationshipInfo:
{
Description: Identifies the billing profile that is linked to another billing profile in indirect purchase motion. ,
Required: False ,
}
string ,
invoiceDay:
{
Description: The day of the month when the invoice for the billing profile is generated. ,
Format: int32 ,
Required: False ,
}
integer ,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
invoiceRecipients:
{
Description: The list of email addresses to receive invoices by email for the billing profile. ,
Required: False ,
}
[
string ,
]
,
poNumber:
{
Description: The default purchase order number that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
shipTo:
{
Description: The default address where the products are shipped, or the services are being used. If a ship to is not specified for a product or a subscription, then this address will be used. ,
Required: False ,
}
string ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
string ,
spendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
spendingLimitDetails:
{
Description: The details of billing profile spending limit. ,
Required: False ,
}
[
{
amount:
{
Description: The initial amount for the billing profile. ,
Required: False ,
}
number ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
startDate:
{
Description: The date when this spending limit goes into effect. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date when this spending limit is no longer in effect. ,
Format: date-time ,
Required: False ,
}
string ,
type:
{
Description: The type of spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
FreeAccount: No description available. ,
Sandbox: No description available. ,
AzureForStudents: No description available. ,
AcademicSponsorship: No description available. ,
AzureConsumptionCredit: No description available. ,
AzurePassSponsorship: No description available. ,
MpnSponsorship: No description available. ,
MSDN: No description available. ,
NonProfitSponsorship: No description available. ,
Sponsorship: No description available. ,
StartupSponsorship: No description available. ,
AzureForStudentsStarter: No description available. ,
VisualStudio: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of current spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Active: No description available. ,
Expired: No description available. ,
LimitReached: No description available. ,
LimitRemoved: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
status:
{
Description: The status of the billing profile. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
statusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
targetClouds:
{
Description: Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. ,
Required: False ,
}
[
string ,
]
,
currentPaymentTerm:
{
Description: The current payment term of the billing profile. ,
Required: False ,
}
string ,
otherPaymentTerms:
{
Description: The other payment terms of the billing profile. ,
Required: False ,
}
[
{
term:
{
Description: Represents duration in netXX format. Always in days. ,
Required: False ,
}
string ,
startDate:
{
Description: The date on when the defined 'Payment Term' will be effective from and is always in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date on when the defined 'Payment Term' will end and is always in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
isDefault:
{
Description: Indicates payment term is the standard payment term. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
billingRelationshipType:
{
Description: Identifies the billing relationship represented by the billing profile. The billing relationship may be between Microsoft, the customer, and/or a third-party. ,
Enum:
{
Other: No description available. ,
Direct: No description available. ,
IndirectCustomer: No description available. ,
IndirectPartner: No description available. ,
CSPPartner: No description available. ,
CSPCustomer: No description available. ,
}
,
Required: False ,
}
enum ,
billTo:
{
Description: Billing address. ,
Required: False ,
}
string ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Information about the enabled azure plans. ,
Required: False ,
}
[
{
productId:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
skuId:
{
Description: The ID that uniquely identifies a sku. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing profile. ,
Required: False ,
}
boolean ,
indirectRelationshipInfo:
{
Description: Identifies the billing profile that is linked to another billing profile in indirect purchase motion. ,
Required: False ,
}
string ,
invoiceDay:
{
Description: The day of the month when the invoice for the billing profile is generated. ,
Format: int32 ,
Required: False ,
}
integer ,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
invoiceRecipients:
{
Description: The list of email addresses to receive invoices by email for the billing profile. ,
Required: False ,
}
[
string ,
]
,
poNumber:
{
Description: The default purchase order number that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
shipTo:
{
Description: The default address where the products are shipped, or the services are being used. If a ship to is not specified for a product or a subscription, then this address will be used. ,
Required: False ,
}
string ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
string ,
spendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
spendingLimitDetails:
{
Description: The details of billing profile spending limit. ,
Required: False ,
}
[
{
amount:
{
Description: The initial amount for the billing profile. ,
Required: False ,
}
number ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
startDate:
{
Description: The date when this spending limit goes into effect. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date when this spending limit is no longer in effect. ,
Format: date-time ,
Required: False ,
}
string ,
type:
{
Description: The type of spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
FreeAccount: No description available. ,
Sandbox: No description available. ,
AzureForStudents: No description available. ,
AcademicSponsorship: No description available. ,
AzureConsumptionCredit: No description available. ,
AzurePassSponsorship: No description available. ,
MpnSponsorship: No description available. ,
MSDN: No description available. ,
NonProfitSponsorship: No description available. ,
Sponsorship: No description available. ,
StartupSponsorship: No description available. ,
AzureForStudentsStarter: No description available. ,
VisualStudio: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of current spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Active: No description available. ,
Expired: No description available. ,
LimitReached: No description available. ,
LimitRemoved: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
status:
{
Description: The status of the billing profile. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
statusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
targetClouds:
{
Description: Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. ,
Required: False ,
}
[
string ,
]
,
currentPaymentTerm:
{
Description: The current payment term of the billing profile. ,
Required: False ,
}
string ,
otherPaymentTerms:
{
Description: The other payment terms of the billing profile. ,
Required: False ,
}
[
{
term:
{
Description: Represents duration in netXX format. Always in days. ,
Required: False ,
}
string ,
startDate:
{
Description: The date on when the defined 'Payment Term' will be effective from and is always in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date on when the defined 'Payment Term' will end and is always in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
isDefault:
{
Description: Indicates payment term is the standard payment term. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
billingRelationshipType:
{
Description: Identifies the billing relationship represented by the billing profile. The billing relationship may be between Microsoft, the customer, and/or a third-party. ,
Enum:
{
Other: No description available. ,
Direct: No description available. ,
IndirectCustomer: No description available. ,
IndirectPartner: No description available. ,
CSPPartner: No description available. ,
CSPCustomer: No description available. ,
}
,
Required: False ,
}
enum ,
billTo:
{
Description: Billing address. ,
Required: False ,
}
string ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Information about the enabled azure plans. ,
Required: False ,
}
[
{
productId:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
skuId:
{
Description: The ID that uniquely identifies a sku. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing profile. ,
Required: False ,
}
boolean ,
indirectRelationshipInfo:
{
Description: Identifies the billing profile that is linked to another billing profile in indirect purchase motion. ,
Required: False ,
}
string ,
invoiceDay:
{
Description: The day of the month when the invoice for the billing profile is generated. ,
Format: int32 ,
Required: False ,
}
integer ,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
invoiceRecipients:
{
Description: The list of email addresses to receive invoices by email for the billing profile. ,
Required: False ,
}
[
string ,
]
,
poNumber:
{
Description: The default purchase order number that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
shipTo:
{
Description: The default address where the products are shipped, or the services are being used. If a ship to is not specified for a product or a subscription, then this address will be used. ,
Required: False ,
}
string ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
string ,
spendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
spendingLimitDetails:
{
Description: The details of billing profile spending limit. ,
Required: False ,
}
[
{
amount:
{
Description: The initial amount for the billing profile. ,
Required: False ,
}
number ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
startDate:
{
Description: The date when this spending limit goes into effect. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date when this spending limit is no longer in effect. ,
Format: date-time ,
Required: False ,
}
string ,
type:
{
Description: The type of spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
FreeAccount: No description available. ,
Sandbox: No description available. ,
AzureForStudents: No description available. ,
AcademicSponsorship: No description available. ,
AzureConsumptionCredit: No description available. ,
AzurePassSponsorship: No description available. ,
MpnSponsorship: No description available. ,
MSDN: No description available. ,
NonProfitSponsorship: No description available. ,
Sponsorship: No description available. ,
StartupSponsorship: No description available. ,
AzureForStudentsStarter: No description available. ,
VisualStudio: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of current spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Active: No description available. ,
Expired: No description available. ,
LimitReached: No description available. ,
LimitRemoved: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
status:
{
Description: The status of the billing profile. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
statusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
targetClouds:
{
Description: Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. ,
Required: False ,
}
[
string ,
]
,
currentPaymentTerm:
{
Description: The current payment term of the billing profile. ,
Required: False ,
}
string ,
otherPaymentTerms:
{
Description: The other payment terms of the billing profile. ,
Required: False ,
}
[
{
term:
{
Description: Represents duration in netXX format. Always in days. ,
Required: False ,
}
string ,
startDate:
{
Description: The date on when the defined 'Payment Term' will be effective from and is always in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date on when the defined 'Payment Term' will end and is always in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
isDefault:
{
Description: Indicates payment term is the standard payment term. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingProfiles_ListByBillingAccount (removed)
Description :  Lists the billing profiles that a user has access to. The operation is supported for billing accounts with agreement of type Microsoft Customer Agreement and Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
includeDeleted:
{
Description: Can be used to get deleted billing profiles. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
billingRelationshipType:
{
Description: Identifies the billing relationship represented by the billing profile. The billing relationship may be between Microsoft, the customer, and/or a third-party. ,
Enum:
{
Other: No description available. ,
Direct: No description available. ,
IndirectCustomer: No description available. ,
IndirectPartner: No description available. ,
CSPPartner: No description available. ,
CSPCustomer: No description available. ,
}
,
Required: False ,
}
enum ,
billTo:
{
Description: Billing address. ,
Required: False ,
}
string ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Information about the enabled azure plans. ,
Required: False ,
}
[
{
productId:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
skuId:
{
Description: The ID that uniquely identifies a sku. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing profile. ,
Required: False ,
}
boolean ,
indirectRelationshipInfo:
{
Description: Identifies the billing profile that is linked to another billing profile in indirect purchase motion. ,
Required: False ,
}
string ,
invoiceDay:
{
Description: The day of the month when the invoice for the billing profile is generated. ,
Format: int32 ,
Required: False ,
}
integer ,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
invoiceRecipients:
{
Description: The list of email addresses to receive invoices by email for the billing profile. ,
Required: False ,
}
[
string ,
]
,
poNumber:
{
Description: The default purchase order number that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
shipTo:
{
Description: The default address where the products are shipped, or the services are being used. If a ship to is not specified for a product or a subscription, then this address will be used. ,
Required: False ,
}
string ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
string ,
spendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
spendingLimitDetails:
{
Description: The details of billing profile spending limit. ,
Required: False ,
}
[
{
amount:
{
Description: The initial amount for the billing profile. ,
Required: False ,
}
number ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
startDate:
{
Description: The date when this spending limit goes into effect. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date when this spending limit is no longer in effect. ,
Format: date-time ,
Required: False ,
}
string ,
type:
{
Description: The type of spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
FreeAccount: No description available. ,
Sandbox: No description available. ,
AzureForStudents: No description available. ,
AcademicSponsorship: No description available. ,
AzureConsumptionCredit: No description available. ,
AzurePassSponsorship: No description available. ,
MpnSponsorship: No description available. ,
MSDN: No description available. ,
NonProfitSponsorship: No description available. ,
Sponsorship: No description available. ,
StartupSponsorship: No description available. ,
AzureForStudentsStarter: No description available. ,
VisualStudio: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of current spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Active: No description available. ,
Expired: No description available. ,
LimitReached: No description available. ,
LimitRemoved: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
status:
{
Description: The status of the billing profile. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
statusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
targetClouds:
{
Description: Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. ,
Required: False ,
}
[
string ,
]
,
currentPaymentTerm:
{
Description: The current payment term of the billing profile. ,
Required: False ,
}
string ,
otherPaymentTerms:
{
Description: The other payment terms of the billing profile. ,
Required: False ,
}
[
{
term:
{
Description: Represents duration in netXX format. Always in days. ,
Required: False ,
}
string ,
startDate:
{
Description: The date on when the defined 'Payment Term' will be effective from and is always in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date on when the defined 'Payment Term' will end and is always in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
isDefault:
{
Description: Indicates payment term is the standard payment term. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingProperty_Get (removed)
Description :  Gets the billing properties for a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingProperty/default
{
subscriptionId:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: True ,
}
string ,
includeBillingCountry:
{
Description: A flag that specifies whether or not to include billing country. ,
Required: False ,
}
boolean ,
includeTransitionStatus:
{
Description: A flag that specifies whether or not to include transition status for billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A billing property. ,
Required: False ,
}
{
billingAccountAgreementType:
{
Description: The type of agreement. ,
Enum:
{
Other: No description available. ,
MicrosoftCustomerAgreement: No description available. ,
EnterpriseAgreement: No description available. ,
MicrosoftOnlineServicesProgram: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
accountAdminNotificationEmailAddress:
{
Description: Notification email address for legacy account. Available for agreement type Microsoft Online Services Program. ,
Required: False ,
}
string ,
billingAccountSoldToCountry:
{
Description: The country of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
string ,
billingAccountStatus:
{
Description: The current status of the billing account. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
UnderReview: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Extended: No description available. ,
Pending: No description available. ,
New: No description available. ,
Expired: No description available. ,
Terminated: No description available. ,
Transferred: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountStatusReasonCode:
{
Description: Reason for the specified billing account status. ,
Enum:
{
Other: No description available. ,
UnusualActivity: No description available. ,
ManuallyTerminated: No description available. ,
Expired: No description available. ,
Transferred: No description available. ,
TerminateProcessing: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountType:
{
Description: The type of customer. ,
Enum:
{
Other: No description available. ,
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
Reseller: No description available. ,
ClassicPartner: No description available. ,
Internal: No description available. ,
Tenant: No description available. ,
Business: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountSubType:
{
Description: The tier of the account. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Individual: No description available. ,
Professional: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
billingCurrency:
{
Description: The billing currency for the subscription. Available for billing accounts with agreement type Enterprise Agreement ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileSpendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfileSpendingLimitDetails:
{
Description: The details of billing profile spending limit. ,
Required: False ,
}
[
{
amount:
{
Description: The initial amount for the billing profile. ,
Required: False ,
}
number ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
startDate:
{
Description: The date when this spending limit goes into effect. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date when this spending limit is no longer in effect. ,
Format: date-time ,
Required: False ,
}
string ,
type:
{
Description: The type of spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
FreeAccount: No description available. ,
Sandbox: No description available. ,
AzureForStudents: No description available. ,
AcademicSponsorship: No description available. ,
AzureConsumptionCredit: No description available. ,
AzurePassSponsorship: No description available. ,
MpnSponsorship: No description available. ,
MSDN: No description available. ,
NonProfitSponsorship: No description available. ,
Sponsorship: No description available. ,
StartupSponsorship: No description available. ,
AzureForStudentsStarter: No description available. ,
VisualStudio: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of current spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Active: No description available. ,
Expired: No description available. ,
LimitReached: No description available. ,
LimitRemoved: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
billingProfileStatus:
{
Description: The status of the billing profile. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfileStatusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfilePaymentMethodFamily:
{
Description: The payment method family of the primary payment method for the billing profile. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfilePaymentMethodType:
{
Description: The payment method type of the primary payment method for the billing profile. ,
Required: False ,
}
string ,
billingTenantId:
{
Description: The Azure AD tenant ID of the billing account for the subscription. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center applied to the subscription. Available for agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. This property can be updated via patch. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerStatus:
{
Description: Identifies the status of an customer. This is an upcoming property that will be populated in the future. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionStatus:
{
Description: Identifies the status of an invoice section. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
Disabled: No description available. ,
UnderReview: No description available. ,
Warned: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceSectionStatusReasonCode:
{
Description: Reason for the specified invoice section status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
isTransitionedBillingAccount:
{
Description: Specifies if the billing account for the subscription is transitioned from a Microsoft Online Service Program to a Microsoft Customer Agreement (MCA) account. Will be present and value will be true if its a transitioned billing account. ,
Required: False ,
}
boolean ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
skuId:
{
Description: The ID that uniquely identifies a sku. ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: The subscription status. ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionBillingStatusDetails:
{
Description: The reason codes for the subscription status. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
subscriptionBillingType:
{
Description: The type of billing subscription. ,
Enum:
{
None: No description available. ,
Benefit: No description available. ,
Free: No description available. ,
Paid: No description available. ,
PrePaid: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionServiceUsageAddress:
{
Description: The address of the individual or organization where service subscription is being used. Available for agreement type Microsoft Online Services Program. This property can be updated via patch. ,
Required: False ,
}
string ,
subscriptionWorkloadType:
{
Description: The Azure workload type of the subscription. ,
Enum:
{
None: No description available. ,
Production: No description available. ,
DevTest: No description available. ,
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDetails:
{
Description: The enrollment details for the subscription. Available for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
isAccountAdmin:
{
Description: Indicates whether user is the account admin. ,
Required: False ,
}
boolean ,
productId:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
productName:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingProperty_Update (removed)
Description :  Updates the billing property of a subscription. Currently, cost center can be updated for billing accounts with agreement type Microsoft Customer Agreement and subscription service usage address can be updated for billing accounts with agreement type Microsoft Online Service Program.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingProperty/default
{
subscriptionId:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: A billing property. ,
Required: True ,
}
{
properties:
{
Description: A billing property. ,
Required: False ,
}
{
billingAccountAgreementType:
{
Description: The type of agreement. ,
Enum:
{
Other: No description available. ,
MicrosoftCustomerAgreement: No description available. ,
EnterpriseAgreement: No description available. ,
MicrosoftOnlineServicesProgram: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
accountAdminNotificationEmailAddress:
{
Description: Notification email address for legacy account. Available for agreement type Microsoft Online Services Program. ,
Required: False ,
}
string ,
billingAccountSoldToCountry:
{
Description: The country of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
string ,
billingAccountStatus:
{
Description: The current status of the billing account. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
UnderReview: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Extended: No description available. ,
Pending: No description available. ,
New: No description available. ,
Expired: No description available. ,
Terminated: No description available. ,
Transferred: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountStatusReasonCode:
{
Description: Reason for the specified billing account status. ,
Enum:
{
Other: No description available. ,
UnusualActivity: No description available. ,
ManuallyTerminated: No description available. ,
Expired: No description available. ,
Transferred: No description available. ,
TerminateProcessing: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountType:
{
Description: The type of customer. ,
Enum:
{
Other: No description available. ,
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
Reseller: No description available. ,
ClassicPartner: No description available. ,
Internal: No description available. ,
Tenant: No description available. ,
Business: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountSubType:
{
Description: The tier of the account. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Individual: No description available. ,
Professional: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
billingCurrency:
{
Description: The billing currency for the subscription. Available for billing accounts with agreement type Enterprise Agreement ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileSpendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfileSpendingLimitDetails:
{
Description: The details of billing profile spending limit. ,
Required: False ,
}
[
{
amount:
{
Description: The initial amount for the billing profile. ,
Required: False ,
}
number ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
startDate:
{
Description: The date when this spending limit goes into effect. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date when this spending limit is no longer in effect. ,
Format: date-time ,
Required: False ,
}
string ,
type:
{
Description: The type of spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
FreeAccount: No description available. ,
Sandbox: No description available. ,
AzureForStudents: No description available. ,
AcademicSponsorship: No description available. ,
AzureConsumptionCredit: No description available. ,
AzurePassSponsorship: No description available. ,
MpnSponsorship: No description available. ,
MSDN: No description available. ,
NonProfitSponsorship: No description available. ,
Sponsorship: No description available. ,
StartupSponsorship: No description available. ,
AzureForStudentsStarter: No description available. ,
VisualStudio: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of current spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Active: No description available. ,
Expired: No description available. ,
LimitReached: No description available. ,
LimitRemoved: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
billingProfileStatus:
{
Description: The status of the billing profile. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfileStatusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfilePaymentMethodFamily:
{
Description: The payment method family of the primary payment method for the billing profile. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfilePaymentMethodType:
{
Description: The payment method type of the primary payment method for the billing profile. ,
Required: False ,
}
string ,
billingTenantId:
{
Description: The Azure AD tenant ID of the billing account for the subscription. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center applied to the subscription. Available for agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. This property can be updated via patch. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerStatus:
{
Description: Identifies the status of an customer. This is an upcoming property that will be populated in the future. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionStatus:
{
Description: Identifies the status of an invoice section. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
Disabled: No description available. ,
UnderReview: No description available. ,
Warned: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceSectionStatusReasonCode:
{
Description: Reason for the specified invoice section status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
isTransitionedBillingAccount:
{
Description: Specifies if the billing account for the subscription is transitioned from a Microsoft Online Service Program to a Microsoft Customer Agreement (MCA) account. Will be present and value will be true if its a transitioned billing account. ,
Required: False ,
}
boolean ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
skuId:
{
Description: The ID that uniquely identifies a sku. ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: The subscription status. ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionBillingStatusDetails:
{
Description: The reason codes for the subscription status. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
subscriptionBillingType:
{
Description: The type of billing subscription. ,
Enum:
{
None: No description available. ,
Benefit: No description available. ,
Free: No description available. ,
Paid: No description available. ,
PrePaid: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionServiceUsageAddress:
{
Description: The address of the individual or organization where service subscription is being used. Available for agreement type Microsoft Online Services Program. This property can be updated via patch. ,
Required: False ,
}
string ,
subscriptionWorkloadType:
{
Description: The Azure workload type of the subscription. ,
Enum:
{
None: No description available. ,
Production: No description available. ,
DevTest: No description available. ,
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDetails:
{
Description: The enrollment details for the subscription. Available for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
isAccountAdmin:
{
Description: Indicates whether user is the account admin. ,
Required: False ,
}
boolean ,
productId:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
productName:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A billing property. ,
Required: False ,
}
{
billingAccountAgreementType:
{
Description: The type of agreement. ,
Enum:
{
Other: No description available. ,
MicrosoftCustomerAgreement: No description available. ,
EnterpriseAgreement: No description available. ,
MicrosoftOnlineServicesProgram: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
accountAdminNotificationEmailAddress:
{
Description: Notification email address for legacy account. Available for agreement type Microsoft Online Services Program. ,
Required: False ,
}
string ,
billingAccountSoldToCountry:
{
Description: The country of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
string ,
billingAccountStatus:
{
Description: The current status of the billing account. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
UnderReview: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Extended: No description available. ,
Pending: No description available. ,
New: No description available. ,
Expired: No description available. ,
Terminated: No description available. ,
Transferred: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountStatusReasonCode:
{
Description: Reason for the specified billing account status. ,
Enum:
{
Other: No description available. ,
UnusualActivity: No description available. ,
ManuallyTerminated: No description available. ,
Expired: No description available. ,
Transferred: No description available. ,
TerminateProcessing: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountType:
{
Description: The type of customer. ,
Enum:
{
Other: No description available. ,
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
Reseller: No description available. ,
ClassicPartner: No description available. ,
Internal: No description available. ,
Tenant: No description available. ,
Business: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountSubType:
{
Description: The tier of the account. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Individual: No description available. ,
Professional: No description available. ,
Enterprise: No description available. ,
}
,
Required: False ,
}
enum ,
billingCurrency:
{
Description: The billing currency for the subscription. Available for billing accounts with agreement type Enterprise Agreement ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileSpendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfileSpendingLimitDetails:
{
Description: The details of billing profile spending limit. ,
Required: False ,
}
[
{
amount:
{
Description: The initial amount for the billing profile. ,
Required: False ,
}
number ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
startDate:
{
Description: The date when this spending limit goes into effect. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date when this spending limit is no longer in effect. ,
Format: date-time ,
Required: False ,
}
string ,
type:
{
Description: The type of spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
FreeAccount: No description available. ,
Sandbox: No description available. ,
AzureForStudents: No description available. ,
AcademicSponsorship: No description available. ,
AzureConsumptionCredit: No description available. ,
AzurePassSponsorship: No description available. ,
MpnSponsorship: No description available. ,
MSDN: No description available. ,
NonProfitSponsorship: No description available. ,
Sponsorship: No description available. ,
StartupSponsorship: No description available. ,
AzureForStudentsStarter: No description available. ,
VisualStudio: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of current spending limit. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
Active: No description available. ,
Expired: No description available. ,
LimitReached: No description available. ,
LimitRemoved: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
billingProfileStatus:
{
Description: The status of the billing profile. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfileStatusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfilePaymentMethodFamily:
{
Description: The payment method family of the primary payment method for the billing profile. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfilePaymentMethodType:
{
Description: The payment method type of the primary payment method for the billing profile. ,
Required: False ,
}
string ,
billingTenantId:
{
Description: The Azure AD tenant ID of the billing account for the subscription. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center applied to the subscription. Available for agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. This property can be updated via patch. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerStatus:
{
Description: Identifies the status of an customer. This is an upcoming property that will be populated in the future. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionStatus:
{
Description: Identifies the status of an invoice section. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
Disabled: No description available. ,
UnderReview: No description available. ,
Warned: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceSectionStatusReasonCode:
{
Description: Reason for the specified invoice section status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
isTransitionedBillingAccount:
{
Description: Specifies if the billing account for the subscription is transitioned from a Microsoft Online Service Program to a Microsoft Customer Agreement (MCA) account. Will be present and value will be true if its a transitioned billing account. ,
Required: False ,
}
boolean ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
skuId:
{
Description: The ID that uniquely identifies a sku. ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: The subscription status. ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionBillingStatusDetails:
{
Description: The reason codes for the subscription status. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
subscriptionBillingType:
{
Description: The type of billing subscription. ,
Enum:
{
None: No description available. ,
Benefit: No description available. ,
Free: No description available. ,
Paid: No description available. ,
PrePaid: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionServiceUsageAddress:
{
Description: The address of the individual or organization where service subscription is being used. Available for agreement type Microsoft Online Services Program. This property can be updated via patch. ,
Required: False ,
}
string ,
subscriptionWorkloadType:
{
Description: The Azure workload type of the subscription. ,
Enum:
{
None: No description available. ,
Production: No description available. ,
DevTest: No description available. ,
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
enrollmentDetails:
{
Description: The enrollment details for the subscription. Available for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
isAccountAdmin:
{
Description: Indicates whether user is the account admin. ,
Required: False ,
}
boolean ,
productId:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
productName:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRequests_ListByBillingProfile (removed)
Description :  The list of billing requests submitted for the billing profile.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRequests
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
additionalInformation:
{
Description: Additional information for the billing request. ,
Required: False ,
}
object ,
reviewedBy:
{
Description: The principal of the request reviewer. Will only be set if request is approved. ,
Required: False ,
}
string ,
reviewalDate:
{
Description: The date and time when the request was reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingAccountPrimaryBillingTenantId:
{
Description: The primary tenant ID of the billing account for which the billing request was submitted. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
createdBy:
{
Description: The principal of the entity who created the request. ,
Required: False ,
}
string ,
creationDate:
{
Description: The date and time when the request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date and time when the request expires. ,
Format: date-time ,
Required: False ,
}
string ,
decisionReason:
{
Description: The reason to approve or decline the request. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The fully qualified ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionDisplayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
justification:
{
Description: Justification for submitting request. ,
Required: False ,
}
string ,
recipients:
{
Description: The recipients of the billing request. ,
Required: False ,
}
[
{
tenantId:
{
Description: The tenant id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
upn:
{
Description: The user principal name of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
}
,
]
,
requestScope:
{
Description: The billing scope for which the request was submitted (ex. '/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}'). ,
Required: False ,
}
string ,
billingScope:
{
Description: The billing scope for which the request will be applied. This is a read only property derived by the service. ,
Required: False ,
}
string ,
status:
{
Description: Status of billing request. ,
Enum:
{
Other: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Declined: No description available. ,
Cancelled: No description available. ,
Completed: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type of billing request. ,
Enum:
{
Other: No description available. ,
InvoiceAccess: No description available. ,
ProvisioningAccess: No description available. ,
RoleAssignment: No description available. ,
UpdateBillingPolicy: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedBy:
{
Description: The principal of the entity who last updated the request. ,
Required: False ,
}
string ,
lastUpdatedDate:
{
Description: Date and time of last update. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRequests_ListByCustomer (removed)
Description :  The list of billing requests submitted for the customer.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/billingRequests
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
additionalInformation:
{
Description: Additional information for the billing request. ,
Required: False ,
}
object ,
reviewedBy:
{
Description: The principal of the request reviewer. Will only be set if request is approved. ,
Required: False ,
}
string ,
reviewalDate:
{
Description: The date and time when the request was reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingAccountPrimaryBillingTenantId:
{
Description: The primary tenant ID of the billing account for which the billing request was submitted. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
createdBy:
{
Description: The principal of the entity who created the request. ,
Required: False ,
}
string ,
creationDate:
{
Description: The date and time when the request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date and time when the request expires. ,
Format: date-time ,
Required: False ,
}
string ,
decisionReason:
{
Description: The reason to approve or decline the request. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The fully qualified ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionDisplayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
justification:
{
Description: Justification for submitting request. ,
Required: False ,
}
string ,
recipients:
{
Description: The recipients of the billing request. ,
Required: False ,
}
[
{
tenantId:
{
Description: The tenant id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
upn:
{
Description: The user principal name of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
}
,
]
,
requestScope:
{
Description: The billing scope for which the request was submitted (ex. '/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}'). ,
Required: False ,
}
string ,
billingScope:
{
Description: The billing scope for which the request will be applied. This is a read only property derived by the service. ,
Required: False ,
}
string ,
status:
{
Description: Status of billing request. ,
Enum:
{
Other: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Declined: No description available. ,
Cancelled: No description available. ,
Completed: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type of billing request. ,
Enum:
{
Other: No description available. ,
InvoiceAccess: No description available. ,
ProvisioningAccess: No description available. ,
RoleAssignment: No description available. ,
UpdateBillingPolicy: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedBy:
{
Description: The principal of the entity who last updated the request. ,
Required: False ,
}
string ,
lastUpdatedDate:
{
Description: Date and time of last update. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRequests_ListByInvoiceSection (removed)
Description :  The list of billing requests submitted for the invoice section.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRequests
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
additionalInformation:
{
Description: Additional information for the billing request. ,
Required: False ,
}
object ,
reviewedBy:
{
Description: The principal of the request reviewer. Will only be set if request is approved. ,
Required: False ,
}
string ,
reviewalDate:
{
Description: The date and time when the request was reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingAccountPrimaryBillingTenantId:
{
Description: The primary tenant ID of the billing account for which the billing request was submitted. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
createdBy:
{
Description: The principal of the entity who created the request. ,
Required: False ,
}
string ,
creationDate:
{
Description: The date and time when the request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date and time when the request expires. ,
Format: date-time ,
Required: False ,
}
string ,
decisionReason:
{
Description: The reason to approve or decline the request. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The fully qualified ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionDisplayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
justification:
{
Description: Justification for submitting request. ,
Required: False ,
}
string ,
recipients:
{
Description: The recipients of the billing request. ,
Required: False ,
}
[
{
tenantId:
{
Description: The tenant id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
upn:
{
Description: The user principal name of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
}
,
]
,
requestScope:
{
Description: The billing scope for which the request was submitted (ex. '/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}'). ,
Required: False ,
}
string ,
billingScope:
{
Description: The billing scope for which the request will be applied. This is a read only property derived by the service. ,
Required: False ,
}
string ,
status:
{
Description: Status of billing request. ,
Enum:
{
Other: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Declined: No description available. ,
Cancelled: No description available. ,
Completed: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type of billing request. ,
Enum:
{
Other: No description available. ,
InvoiceAccess: No description available. ,
ProvisioningAccess: No description available. ,
RoleAssignment: No description available. ,
UpdateBillingPolicy: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedBy:
{
Description: The principal of the entity who last updated the request. ,
Required: False ,
}
string ,
lastUpdatedDate:
{
Description: Date and time of last update. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRequests_ListByBillingAccount (removed)
Description :  The list of billing requests submitted for the billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRequests
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
additionalInformation:
{
Description: Additional information for the billing request. ,
Required: False ,
}
object ,
reviewedBy:
{
Description: The principal of the request reviewer. Will only be set if request is approved. ,
Required: False ,
}
string ,
reviewalDate:
{
Description: The date and time when the request was reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingAccountPrimaryBillingTenantId:
{
Description: The primary tenant ID of the billing account for which the billing request was submitted. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
createdBy:
{
Description: The principal of the entity who created the request. ,
Required: False ,
}
string ,
creationDate:
{
Description: The date and time when the request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date and time when the request expires. ,
Format: date-time ,
Required: False ,
}
string ,
decisionReason:
{
Description: The reason to approve or decline the request. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The fully qualified ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionDisplayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
justification:
{
Description: Justification for submitting request. ,
Required: False ,
}
string ,
recipients:
{
Description: The recipients of the billing request. ,
Required: False ,
}
[
{
tenantId:
{
Description: The tenant id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
upn:
{
Description: The user principal name of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
}
,
]
,
requestScope:
{
Description: The billing scope for which the request was submitted (ex. '/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}'). ,
Required: False ,
}
string ,
billingScope:
{
Description: The billing scope for which the request will be applied. This is a read only property derived by the service. ,
Required: False ,
}
string ,
status:
{
Description: Status of billing request. ,
Enum:
{
Other: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Declined: No description available. ,
Cancelled: No description available. ,
Completed: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type of billing request. ,
Enum:
{
Other: No description available. ,
InvoiceAccess: No description available. ,
ProvisioningAccess: No description available. ,
RoleAssignment: No description available. ,
UpdateBillingPolicy: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedBy:
{
Description: The principal of the entity who last updated the request. ,
Required: False ,
}
string ,
lastUpdatedDate:
{
Description: Date and time of last update. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRequests_Get (removed)
Description :  Gets a billing request by its ID.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingRequests/{billingRequestName}
{
billingRequestName:
{
Description: The ID that uniquely identifies a billing request. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
additionalInformation:
{
Description: Additional information for the billing request. ,
Required: False ,
}
object ,
reviewedBy:
{
Description: The principal of the request reviewer. Will only be set if request is approved. ,
Required: False ,
}
string ,
reviewalDate:
{
Description: The date and time when the request was reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingAccountPrimaryBillingTenantId:
{
Description: The primary tenant ID of the billing account for which the billing request was submitted. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
createdBy:
{
Description: The principal of the entity who created the request. ,
Required: False ,
}
string ,
creationDate:
{
Description: The date and time when the request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date and time when the request expires. ,
Format: date-time ,
Required: False ,
}
string ,
decisionReason:
{
Description: The reason to approve or decline the request. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The fully qualified ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionDisplayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
justification:
{
Description: Justification for submitting request. ,
Required: False ,
}
string ,
recipients:
{
Description: The recipients of the billing request. ,
Required: False ,
}
[
{
tenantId:
{
Description: The tenant id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
upn:
{
Description: The user principal name of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
}
,
]
,
requestScope:
{
Description: The billing scope for which the request was submitted (ex. '/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}'). ,
Required: False ,
}
string ,
billingScope:
{
Description: The billing scope for which the request will be applied. This is a read only property derived by the service. ,
Required: False ,
}
string ,
status:
{
Description: Status of billing request. ,
Enum:
{
Other: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Declined: No description available. ,
Cancelled: No description available. ,
Completed: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type of billing request. ,
Enum:
{
Other: No description available. ,
InvoiceAccess: No description available. ,
ProvisioningAccess: No description available. ,
RoleAssignment: No description available. ,
UpdateBillingPolicy: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedBy:
{
Description: The principal of the entity who last updated the request. ,
Required: False ,
}
string ,
lastUpdatedDate:
{
Description: Date and time of last update. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRequests_CreateOrUpdate (removed)
Description :  Create or update a billing request.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingRequests/{billingRequestName}
{
billingRequestName:
{
Description: The ID that uniquely identifies a billing request. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests. ,
Required: True ,
}
{
properties:
{
Description: A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
additionalInformation:
{
Description: Additional information for the billing request. ,
Required: False ,
}
object ,
reviewedBy:
{
Description: The principal of the request reviewer. Will only be set if request is approved. ,
Required: False ,
}
string ,
reviewalDate:
{
Description: The date and time when the request was reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingAccountPrimaryBillingTenantId:
{
Description: The primary tenant ID of the billing account for which the billing request was submitted. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
createdBy:
{
Description: The principal of the entity who created the request. ,
Required: False ,
}
string ,
creationDate:
{
Description: The date and time when the request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date and time when the request expires. ,
Format: date-time ,
Required: False ,
}
string ,
decisionReason:
{
Description: The reason to approve or decline the request. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The fully qualified ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionDisplayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
justification:
{
Description: Justification for submitting request. ,
Required: False ,
}
string ,
recipients:
{
Description: The recipients of the billing request. ,
Required: False ,
}
[
{
tenantId:
{
Description: The tenant id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
upn:
{
Description: The user principal name of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
}
,
]
,
requestScope:
{
Description: The billing scope for which the request was submitted (ex. '/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}'). ,
Required: False ,
}
string ,
billingScope:
{
Description: The billing scope for which the request will be applied. This is a read only property derived by the service. ,
Required: False ,
}
string ,
status:
{
Description: Status of billing request. ,
Enum:
{
Other: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Declined: No description available. ,
Cancelled: No description available. ,
Completed: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type of billing request. ,
Enum:
{
Other: No description available. ,
InvoiceAccess: No description available. ,
ProvisioningAccess: No description available. ,
RoleAssignment: No description available. ,
UpdateBillingPolicy: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedBy:
{
Description: The principal of the entity who last updated the request. ,
Required: False ,
}
string ,
lastUpdatedDate:
{
Description: Date and time of last update. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
additionalInformation:
{
Description: Additional information for the billing request. ,
Required: False ,
}
object ,
reviewedBy:
{
Description: The principal of the request reviewer. Will only be set if request is approved. ,
Required: False ,
}
string ,
reviewalDate:
{
Description: The date and time when the request was reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingAccountPrimaryBillingTenantId:
{
Description: The primary tenant ID of the billing account for which the billing request was submitted. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
createdBy:
{
Description: The principal of the entity who created the request. ,
Required: False ,
}
string ,
creationDate:
{
Description: The date and time when the request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date and time when the request expires. ,
Format: date-time ,
Required: False ,
}
string ,
decisionReason:
{
Description: The reason to approve or decline the request. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The fully qualified ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionDisplayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
justification:
{
Description: Justification for submitting request. ,
Required: False ,
}
string ,
recipients:
{
Description: The recipients of the billing request. ,
Required: False ,
}
[
{
tenantId:
{
Description: The tenant id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
upn:
{
Description: The user principal name of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
}
,
]
,
requestScope:
{
Description: The billing scope for which the request was submitted (ex. '/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}'). ,
Required: False ,
}
string ,
billingScope:
{
Description: The billing scope for which the request will be applied. This is a read only property derived by the service. ,
Required: False ,
}
string ,
status:
{
Description: Status of billing request. ,
Enum:
{
Other: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Declined: No description available. ,
Cancelled: No description available. ,
Completed: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type of billing request. ,
Enum:
{
Other: No description available. ,
InvoiceAccess: No description available. ,
ProvisioningAccess: No description available. ,
RoleAssignment: No description available. ,
UpdateBillingPolicy: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedBy:
{
Description: The principal of the entity who last updated the request. ,
Required: False ,
}
string ,
lastUpdatedDate:
{
Description: Date and time of last update. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location: string ,
retry-after: integer ,
}
,
$schema:
{
Description: A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests. ,
}
{
properties:
{
Description: A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
additionalInformation:
{
Description: Additional information for the billing request. ,
Required: False ,
}
object ,
reviewedBy:
{
Description: The principal of the request reviewer. Will only be set if request is approved. ,
Required: False ,
}
string ,
reviewalDate:
{
Description: The date and time when the request was reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingAccountPrimaryBillingTenantId:
{
Description: The primary tenant ID of the billing account for which the billing request was submitted. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
createdBy:
{
Description: The principal of the entity who created the request. ,
Required: False ,
}
string ,
creationDate:
{
Description: The date and time when the request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date and time when the request expires. ,
Format: date-time ,
Required: False ,
}
string ,
decisionReason:
{
Description: The reason to approve or decline the request. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The fully qualified ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionDisplayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
justification:
{
Description: Justification for submitting request. ,
Required: False ,
}
string ,
recipients:
{
Description: The recipients of the billing request. ,
Required: False ,
}
[
{
tenantId:
{
Description: The tenant id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
upn:
{
Description: The user principal name of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
}
,
]
,
requestScope:
{
Description: The billing scope for which the request was submitted (ex. '/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}'). ,
Required: False ,
}
string ,
billingScope:
{
Description: The billing scope for which the request will be applied. This is a read only property derived by the service. ,
Required: False ,
}
string ,
status:
{
Description: Status of billing request. ,
Enum:
{
Other: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Declined: No description available. ,
Cancelled: No description available. ,
Completed: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type of billing request. ,
Enum:
{
Other: No description available. ,
InvoiceAccess: No description available. ,
ProvisioningAccess: No description available. ,
RoleAssignment: No description available. ,
UpdateBillingPolicy: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedBy:
{
Description: The principal of the entity who last updated the request. ,
Required: False ,
}
string ,
lastUpdatedDate:
{
Description: Date and time of last update. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRequests_ListByUser (removed)
Description :  The list of billing requests submitted by a user.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingRequests
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
additionalInformation:
{
Description: Additional information for the billing request. ,
Required: False ,
}
object ,
reviewedBy:
{
Description: The principal of the request reviewer. Will only be set if request is approved. ,
Required: False ,
}
string ,
reviewalDate:
{
Description: The date and time when the request was reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingAccountPrimaryBillingTenantId:
{
Description: The primary tenant ID of the billing account for which the billing request was submitted. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
createdBy:
{
Description: The principal of the entity who created the request. ,
Required: False ,
}
string ,
creationDate:
{
Description: The date and time when the request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date and time when the request expires. ,
Format: date-time ,
Required: False ,
}
string ,
decisionReason:
{
Description: The reason to approve or decline the request. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The fully qualified ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: False ,
}
string ,
subscriptionDisplayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
justification:
{
Description: Justification for submitting request. ,
Required: False ,
}
string ,
recipients:
{
Description: The recipients of the billing request. ,
Required: False ,
}
[
{
tenantId:
{
Description: The tenant id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
objectId:
{
Description: The object id of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
upn:
{
Description: The user principal name of the principal who has interacted with a billing entity. ,
Required: False ,
}
string ,
}
,
]
,
requestScope:
{
Description: The billing scope for which the request was submitted (ex. '/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}'). ,
Required: False ,
}
string ,
billingScope:
{
Description: The billing scope for which the request will be applied. This is a read only property derived by the service. ,
Required: False ,
}
string ,
status:
{
Description: Status of billing request. ,
Enum:
{
Other: No description available. ,
Pending: No description available. ,
Approved: No description available. ,
Declined: No description available. ,
Cancelled: No description available. ,
Completed: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Type of billing request. ,
Enum:
{
Other: No description available. ,
InvoiceAccess: No description available. ,
ProvisioningAccess: No description available. ,
RoleAssignment: No description available. ,
UpdateBillingPolicy: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedBy:
{
Description: The principal of the entity who last updated the request. ,
Required: False ,
}
string ,
lastUpdatedDate:
{
Description: Date and time of last update. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_DeleteByBillingProfile (removed)
Description :  Deletes a role assignment on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_ListByBillingProfile (removed)
Description :  Lists the role assignments for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleAssignments
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_CreateByBillingProfile (removed)
Description :  Adds a role assignment on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/createBillingRoleAssignment
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of the billing role assignment. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_DeleteByCustomer (removed)
Description :  Deletes a role assignment on a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_GetByCustomer (removed)
Description :  Gets a role assignment for the caller on a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_ListByCustomer (removed)
Description :  Lists the role assignments for the caller on customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/billingRoleAssignments
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_CreateByCustomer (removed)
Description :  Adds a role assignment on a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/createBillingRoleAssignment
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of the billing role assignment. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_ResolveByCustomer (removed)
Description :  Lists the role assignments for the caller on a customer while fetching user info for each role assignment. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/resolveBillingRoleAssignments
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
resolveScopeDisplayNames:
{
Description: Resolves the scope display name for each of the role assignments. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_DeleteByInvoiceSection (removed)
Description :  Deletes a role assignment on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleAssignments
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_CreateByInvoiceSection (removed)
Description :  Adds a role assignment on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/createBillingRoleAssignment
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of the billing role assignment. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_ResolveByInvoiceSection (removed)
Description :  Lists the role assignments for the caller on an invoice section while fetching user info for each role assignment. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/resolveBillingRoleAssignments
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
resolveScopeDisplayNames:
{
Description: Resolves the scope display name for each of the role assignments. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_ResolveByBillingProfile (removed)
Description :  Lists the role assignments for the caller on an billing profile while fetching user info for each role assignment. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/resolveBillingRoleAssignments
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
resolveScopeDisplayNames:
{
Description: Resolves the scope display name for each of the role assignments. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_DeleteByBillingAccount (removed)
Description :  Deletes a role assignment on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_CreateOrUpdateByBillingAccount (removed)
Description :  Create or update a billing role assignment. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments/{billingRoleAssignmentName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of the billing role assignment. ,
Required: True ,
}
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location: string ,
retry-after: integer ,
}
,
$schema:
{
Description: The properties of the billing role assignment. ,
}
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_CreateByBillingAccount (removed)
Description :  Adds a role assignment on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/createBillingRoleAssignment
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of the billing role assignment. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_DeleteByDepartment (removed)
Description :  Deletes a role assignment on a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_CreateOrUpdateByDepartment (removed)
Description :  Create or update a billing role assignment. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleAssignments/{billingRoleAssignmentName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
departmentName:
{
Description: The name of the department. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of the billing role assignment. ,
Required: True ,
}
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location: string ,
retry-after: integer ,
}
,
$schema:
{
Description: The properties of the billing role assignment. ,
}
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_ListByDepartment (removed)
Description :  Lists the role assignments for the caller on a department. The operation is supported for billing accounts of type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_DeleteByEnrollmentAccount (removed)
Description :  Deletes a role assignment on a enrollment Account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_CreateOrUpdateByEnrollmentAccount (removed)
Description :  Create or update a billing role assignment. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingRoleAssignments/{billingRoleAssignmentName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
enrollmentAccountName:
{
Description: The name of the enrollment account. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of the billing role assignment. ,
Required: True ,
}
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location: string ,
retry-after: integer ,
}
,
$schema:
{
Description: The properties of the billing role assignment. ,
}
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_ListByEnrollmentAccount (removed)
Description :  Lists the role assignments for the caller on a enrollment account. The operation is supported for billing accounts of type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleAssignments_ResolveByBillingAccount (removed)
Description :  Lists the role assignments for the caller on a billing account while fetching user info for each role assignment. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/resolveBillingRoleAssignments
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
resolveScopeDisplayNames:
{
Description: Resolves the scope display name for each of the role assignments. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing role assignment. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
createdOn:
{
Description: The date the role assignment was created. ,
Format: date-time ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The object ID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalPuid:
{
Description: The principal PUID of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedOn:
{
Description: The date the role assignment was modified. ,
Format: date-time ,
Required: False ,
}
string ,
modifiedByPrincipalPuid:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByUserEmailAddress:
{
Description: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
modifiedByPrincipalId:
{
Description: The principal PUID of the user who modified the role assignment. ,
Required: False ,
}
string ,
modifiedByPrincipalTenantId:
{
Description: The tenant Id of the user who modified the role assignment. ,
Required: False ,
}
string ,
principalPuid:
{
Description: The principal PUID of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalId:
{
Description: The object id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
principalTenantName:
{
Description: The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. ,
Required: False ,
}
string ,
principalDisplayName:
{
Description: The display name of the principal to whom the role was assigned. ,
Required: False ,
}
string ,
principalType:
{
Description: The type of a role Assignment. ,
Enum:
{
Unknown: No description available. ,
None: No description available. ,
User: No description available. ,
Group: No description available. ,
DirectoryRole: No description available. ,
ServicePrincipal: No description available. ,
Everyone: No description available. ,
}
,
Required: False ,
}
enum ,
billingRequestId:
{
Description: The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The fully qualified ID that uniquely identifies a billing account. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleDefinition_GetByBillingProfile (removed)
Description :  Gets the definition for a role on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleDefinition_ListByBillingProfile (removed)
Description :  Lists the role definitions for a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleDefinition_GetByCustomer (removed)
Description :  Gets the definition for a role on a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleDefinition_ListByCustomer (removed)
Description :  Lists the role definitions for a customer. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleDefinition_GetByInvoiceSection (removed)
Description :  Gets the definition for a role on an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleDefinition_ListByInvoiceSection (removed)
Description :  Lists the role definitions for an invoice section. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleDefinition_GetByBillingAccount (removed)
Description :  Gets the definition for a role on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleDefinition_ListByBillingAccount (removed)
Description :  Lists the role definitions for a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleDefinition_GetByDepartment (removed)
Description :  Gets the definition for a role on a department. The operation is supported for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleDefinition_ListByDepartment (removed)
Description :  List the definition for a department. The operation is supported for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleDefinition_GetByEnrollmentAccount (removed)
Description :  Gets the definition for a role on an enrollment account. The operation is supported for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingRoleDefinition_ListByEnrollmentAccount (removed)
Description :  List the definition for an enrollment account. The operation is supported for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SavingsPlanOrders_GetByBillingAccount (removed)
Description :  Get a savings plan order by billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
savingsPlanOrderId:
{
Description: Order ID of the savings plan ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
expand:
{
Description: May be used to expand the planInformation. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: Savings plan SKU ,
Required: True ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Savings plan order properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the savings plan, e.g. Succeeded ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing SavingsPlan ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Fully-qualified identifier of the billing profile where the savings plan is applied. Present only for Field-led or Customer-led customers. ,
Required: False ,
}
string ,
customerId:
{
Description: Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: Fully-qualified identifier of the billing account where the savings plan is applied. ,
Required: False ,
}
string ,
term:
{
Description: Represents the Savings plan term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly purchases. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
benefitStartTime:
{
Description: DateTime when the savings plan benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: DateTime when the savings plan will expire. ,
Format: date-time ,
Required: False ,
}
string ,
planInformation:
{
Description: Information describing the type of billing plan for this savings plan. ,
Required: False ,
}
{
pricingCurrencyTotal:
{
Description: Amount of money to be paid for the Order. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
startDate:
{
Description: Date when the billing plan has started. ,
Format: date ,
Required: False ,
}
string ,
nextPaymentDueDate:
{
Description: For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off. ,
Format: date ,
Required: False ,
}
string ,
transactions:
{
Required: False ,
}
[
{
dueDate:
{
Description: Date when the payment needs to be done. ,
Format: date ,
Required: False ,
}
string ,
paymentDate:
{
Description: Date when the transaction is completed. Null when it is scheduled. ,
Format: date ,
Required: False ,
}
string ,
pricingCurrencyTotal:
{
Description: Amount in pricing currency. Tax not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Amount charged in Billing currency. Tax not included. Is null for future payments ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
status:
{
Description: Describes whether the payment is completed, failed, pending, cancelled or scheduled in the future. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Scheduled: No description available. ,
Cancelled: No description available. ,
Completed: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
extendedStatusInfo:
{
Description: Extended status information ,
Required: False ,
}
{
statusCode:
{
Description: Status code providing additional information. ,
Required: False ,
}
string ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to credit line check failure ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription that has failed credit line check. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
savingsPlans:
{
Required: False ,
}
[
string ,
]
,
extendedStatusInfo:
{
Description: Extended status information ,
Required: False ,
}
{
statusCode:
{
Description: Status code providing additional information. ,
Required: False ,
}
string ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to credit line check failure ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription that has failed credit line check. ,
Required: False ,
}
string ,
}
,
}
,
productCode:
{
Description: Represents UPN ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SavingsPlanOrders_ListByBillingAccount (removed)
Description :  List all Savings plan orders by billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
skiptoken:
{
Description: The number of savings plans to skip from the list before returning results ,
Required: False ,
}
number ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
sku:
{
Description: Savings plan SKU ,
Required: True ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Savings plan order properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the savings plan, e.g. Succeeded ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing SavingsPlan ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Fully-qualified identifier of the billing profile where the savings plan is applied. Present only for Field-led or Customer-led customers. ,
Required: False ,
}
string ,
customerId:
{
Description: Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: Fully-qualified identifier of the billing account where the savings plan is applied. ,
Required: False ,
}
string ,
term:
{
Description: Represents the Savings plan term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly purchases. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
benefitStartTime:
{
Description: DateTime when the savings plan benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: DateTime when the savings plan will expire. ,
Format: date-time ,
Required: False ,
}
string ,
planInformation:
{
Description: Information describing the type of billing plan for this savings plan. ,
Required: False ,
}
{
pricingCurrencyTotal:
{
Description: Amount of money to be paid for the Order. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
startDate:
{
Description: Date when the billing plan has started. ,
Format: date ,
Required: False ,
}
string ,
nextPaymentDueDate:
{
Description: For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off. ,
Format: date ,
Required: False ,
}
string ,
transactions:
{
Required: False ,
}
[
{
dueDate:
{
Description: Date when the payment needs to be done. ,
Format: date ,
Required: False ,
}
string ,
paymentDate:
{
Description: Date when the transaction is completed. Null when it is scheduled. ,
Format: date ,
Required: False ,
}
string ,
pricingCurrencyTotal:
{
Description: Amount in pricing currency. Tax not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Amount charged in Billing currency. Tax not included. Is null for future payments ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
status:
{
Description: Describes whether the payment is completed, failed, pending, cancelled or scheduled in the future. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Scheduled: No description available. ,
Cancelled: No description available. ,
Completed: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
extendedStatusInfo:
{
Description: Extended status information ,
Required: False ,
}
{
statusCode:
{
Description: Status code providing additional information. ,
Required: False ,
}
string ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to credit line check failure ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription that has failed credit line check. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
savingsPlans:
{
Required: False ,
}
[
string ,
]
,
extendedStatusInfo:
{
Description: Extended status information ,
Required: False ,
}
{
statusCode:
{
Description: Status code providing additional information. ,
Required: False ,
}
string ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to credit line check failure ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription that has failed credit line check. ,
Required: False ,
}
string ,
}
,
}
,
productCode:
{
Description: Represents UPN ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Url to get the next page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SavingsPlans_ListBySavingsPlanOrder (removed)
Description :  List savings plans in an order by billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
savingsPlanOrderId:
{
Description: Order ID of the savings plan ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
sku:
{
Description: Savings plan SKU ,
Required: True ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Savings plan properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Creating: No description available. ,
Failed: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the savings plan for display, e.g. Succeeded ,
Required: False ,
}
string ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the savings plan for display, e.g. Shared ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing SavingsPlan ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Fully-qualified identifier of the billing profile where the savings plan is applied. Present only for Field-led or Customer-led customers. ,
Required: False ,
}
string ,
customerId:
{
Description: Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: Fully-qualified identifier of the billing account where the savings plan is applied. ,
Required: False ,
}
string ,
term:
{
Description: Represents the Savings plan term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
renewSource:
{
Description: SavingsPlan Id of the SavingsPlan from which this SavingsPlan is renewed. ,
Required: False ,
}
string ,
renewDestination:
{
Description: SavingsPlan Id of the SavingsPlan which is purchased because of renew. ,
Required: False ,
}
string ,
renewProperties:
{
Description: Properties specific to renew. ,
Required: False ,
}
{
purchaseProperties:
{
Description: Purchase request. ,
Required: False ,
}
{
sku:
{
Description: The SKU to be applied for this resource ,
Required: False ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Purchase request properties. ,
Required: False ,
}
{
displayName:
{
Description: Friendly name of the savings plan ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing SavingsPlan ,
Required: False ,
}
string ,
term:
{
Description: Represents the Savings plan term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly purchases. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: Commitment grain. ,
Enum:
{
Hourly: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit is applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription where the benefit is applied. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group where the benefit is applied. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly purchases. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit is applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription where the benefit is applied. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group where the benefit is applied. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: Commitment grain. ,
Enum:
{
Hourly: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
effectiveDateTime:
{
Description: DateTime of the savings plan starting when this version is effective from. ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the savings plan benefit starts. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the savings plan will expire. ,
Format: date-time ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: Date time when the savings plan was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
utilization:
{
Description: Savings plan utilization ,
Required: False ,
}
{
trend:
{
Description: The trend for a savings plan's utilization ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a savings plan's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
extendedStatusInfo:
{
Description: Extended status information ,
Required: False ,
}
{
statusCode:
{
Description: Status code providing additional information. ,
Required: False ,
}
string ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to credit line check failure ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription that has failed credit line check. ,
Required: False ,
}
string ,
}
,
}
,
productCode:
{
Description: Represents UPN ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Url to get the next page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SavingsPlans_ListByBillingAccount (removed)
Description :  List savings plans by billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlans
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
skiptoken:
{
Description: The number of savings plans to skip from the list before returning results ,
Required: False ,
}
number ,
take:
{
Description: The number of savings plans to return ,
Required: False ,
}
number ,
selectedState:
{
Description: The selected provisioning state ,
Required: False ,
}
string ,
refreshSummary:
{
Description: To indicate whether to refresh the roll up counts of the savings plans group by provisioning states ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
summary:
{
Description: The roll out count summary of the savings plans ,
Required: False ,
}
{
succeededCount:
{
Description: The number of savings plans in Succeeded state ,
Required: False ,
}
number ,
failedCount:
{
Description: The number of savings plans in Failed state ,
Required: False ,
}
number ,
expiringCount:
{
Description: The number of savings plans in Expiring state ,
Required: False ,
}
number ,
expiredCount:
{
Description: The number of savings plans in Expired state ,
Required: False ,
}
number ,
pendingCount:
{
Description: The number of savings plans in Pending state ,
Required: False ,
}
number ,
cancelledCount:
{
Description: The number of savings plans in Cancelled state ,
Required: False ,
}
number ,
processingCount:
{
Description: The number of savings plans in Processing state ,
Required: False ,
}
number ,
noBenefitCount:
{
Description: The number of savings plans in No Benefit state ,
Required: False ,
}
number ,
warningCount:
{
Description: The number of savings plans in Warning state ,
Required: False ,
}
number ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SavingsPlans_GetByBillingAccount (removed)
Description :  Get savings plan by billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
savingsPlanOrderId:
{
Description: Order ID of the savings plan ,
Required: True ,
}
string ,
savingsPlanId:
{
Description: ID of the savings plan ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
expand:
{
Description: May be used to expand the planInformation. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: Savings plan SKU ,
Required: True ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Savings plan properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Creating: No description available. ,
Failed: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the savings plan for display, e.g. Succeeded ,
Required: False ,
}
string ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the savings plan for display, e.g. Shared ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing SavingsPlan ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Fully-qualified identifier of the billing profile where the savings plan is applied. Present only for Field-led or Customer-led customers. ,
Required: False ,
}
string ,
customerId:
{
Description: Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: Fully-qualified identifier of the billing account where the savings plan is applied. ,
Required: False ,
}
string ,
term:
{
Description: Represents the Savings plan term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
renewSource:
{
Description: SavingsPlan Id of the SavingsPlan from which this SavingsPlan is renewed. ,
Required: False ,
}
string ,
renewDestination:
{
Description: SavingsPlan Id of the SavingsPlan which is purchased because of renew. ,
Required: False ,
}
string ,
renewProperties:
{
Description: Properties specific to renew. ,
Required: False ,
}
{
purchaseProperties:
{
Description: Purchase request. ,
Required: False ,
}
{
sku:
{
Description: The SKU to be applied for this resource ,
Required: False ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Purchase request properties. ,
Required: False ,
}
{
displayName:
{
Description: Friendly name of the savings plan ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing SavingsPlan ,
Required: False ,
}
string ,
term:
{
Description: Represents the Savings plan term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly purchases. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: Commitment grain. ,
Enum:
{
Hourly: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit is applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription where the benefit is applied. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group where the benefit is applied. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly purchases. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit is applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription where the benefit is applied. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group where the benefit is applied. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: Commitment grain. ,
Enum:
{
Hourly: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
effectiveDateTime:
{
Description: DateTime of the savings plan starting when this version is effective from. ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the savings plan benefit starts. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the savings plan will expire. ,
Format: date-time ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: Date time when the savings plan was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
utilization:
{
Description: Savings plan utilization ,
Required: False ,
}
{
trend:
{
Description: The trend for a savings plan's utilization ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a savings plan's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
extendedStatusInfo:
{
Description: Extended status information ,
Required: False ,
}
{
statusCode:
{
Description: Status code providing additional information. ,
Required: False ,
}
string ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to credit line check failure ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription that has failed credit line check. ,
Required: False ,
}
string ,
}
,
}
,
productCode:
{
Description: Represents UPN ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SavingsPlans_UpdateByBillingAccount (removed)
Description :  Update savings plan by billing account.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
savingsPlanOrderId:
{
Description: Order ID of the savings plan ,
Required: True ,
}
string ,
savingsPlanId:
{
Description: ID of the savings plan ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
body:
{
Description: Request body for patching a savings plan order alias ,
Required: True ,
}
{
properties:
{
Description: Savings plan patch request ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit is applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription where the benefit is applied. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group where the benefit is applied. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
renewProperties:
{
Description: Properties specific to renew. ,
Required: False ,
}
{
purchaseProperties:
{
Description: Purchase request. ,
Required: False ,
}
{
sku:
{
Description: The SKU to be applied for this resource ,
Required: False ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Purchase request properties. ,
Required: False ,
}
{
displayName:
{
Description: Friendly name of the savings plan ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing SavingsPlan ,
Required: False ,
}
string ,
term:
{
Description: Represents the Savings plan term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly purchases. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: Commitment grain. ,
Enum:
{
Hourly: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit is applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription where the benefit is applied. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group where the benefit is applied. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}
,
sku:
{
Description: The SKU to be applied for this resource ,
Required: False ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Tags for this reservation ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
sku:
{
Description: Savings plan SKU ,
Required: True ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Savings plan properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Creating: No description available. ,
Failed: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the savings plan for display, e.g. Succeeded ,
Required: False ,
}
string ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the savings plan for display, e.g. Shared ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing SavingsPlan ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Fully-qualified identifier of the billing profile where the savings plan is applied. Present only for Field-led or Customer-led customers. ,
Required: False ,
}
string ,
customerId:
{
Description: Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: Fully-qualified identifier of the billing account where the savings plan is applied. ,
Required: False ,
}
string ,
term:
{
Description: Represents the Savings plan term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
renewSource:
{
Description: SavingsPlan Id of the SavingsPlan from which this SavingsPlan is renewed. ,
Required: False ,
}
string ,
renewDestination:
{
Description: SavingsPlan Id of the SavingsPlan which is purchased because of renew. ,
Required: False ,
}
string ,
renewProperties:
{
Description: Properties specific to renew. ,
Required: False ,
}
{
purchaseProperties:
{
Description: Purchase request. ,
Required: False ,
}
{
sku:
{
Description: The SKU to be applied for this resource ,
Required: False ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Purchase request properties. ,
Required: False ,
}
{
displayName:
{
Description: Friendly name of the savings plan ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing SavingsPlan ,
Required: False ,
}
string ,
term:
{
Description: Represents the Savings plan term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly purchases. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: Commitment grain. ,
Enum:
{
Hourly: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit is applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription where the benefit is applied. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group where the benefit is applied. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly purchases. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit is applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription where the benefit is applied. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group where the benefit is applied. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: Commitment grain. ,
Enum:
{
Hourly: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
effectiveDateTime:
{
Description: DateTime of the savings plan starting when this version is effective from. ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the savings plan benefit starts. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the savings plan will expire. ,
Format: date-time ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: Date time when the savings plan was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
utilization:
{
Description: Savings plan utilization ,
Required: False ,
}
{
trend:
{
Description: The trend for a savings plan's utilization ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a savings plan's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
extendedStatusInfo:
{
Description: Extended status information ,
Required: False ,
}
{
statusCode:
{
Description: Status code providing additional information. ,
Required: False ,
}
string ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties specific to credit line check failure ,
Required: False ,
}
{
subscriptionId:
{
Description: The subscription that has failed credit line check. ,
Required: False ,
}
string ,
}
,
}
,
productCode:
{
Description: Represents UPN ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
location:
{
Description: URL for determining when an operation has completed. Only use this value only when Azure-AsyncOperation isn't returned. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SavingsPlans_ValidateUpdateByBillingAccount (removed)
Description :  Validate savings plan patch by billing account.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/validate
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
savingsPlanOrderId:
{
Description: Order ID of the savings plan ,
Required: True ,
}
string ,
savingsPlanId:
{
Description: ID of the savings plan ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
body:
{
Description: Request body for patching a savings plan order alias ,
Required: True ,
}
{
benefits:
{
Description: The benefits of a savings plan. ,
Required: False ,
}
[
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit is applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription where the benefit is applied. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group where the benefit is applied. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
renewProperties:
{
Description: Properties specific to renew. ,
Required: False ,
}
{
purchaseProperties:
{
Description: Purchase request. ,
Required: False ,
}
{
sku:
{
Description: The SKU to be applied for this resource ,
Required: False ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Purchase request properties. ,
Required: False ,
}
{
displayName:
{
Description: Friendly name of the savings plan ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing SavingsPlan ,
Required: False ,
}
string ,
term:
{
Description: Represents the Savings plan term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly purchases. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: Commitment grain. ,
Enum:
{
Hourly: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the savings plan where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit is applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription where the benefit is applied. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group where the benefit is applied. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}
,
]
,
}
,
}

⚐ Response (200)

{
benefits:
{
Required: False ,
}
[
{
valid:
{
Description: Indicates if the provided input is valid ,
Required: False ,
}
boolean ,
reasonCode:
{
Description: Failure reason code if the provided input is invalid ,
Required: False ,
}
string ,
reason:
{
Description: Failure reason if the provided input is invalid ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Url to get the next page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptions_GetByBillingProfile (removed)
Description :  Gets a subscription by its billing profile and ID. The operation is supported for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingSubscriptions/{billingSubscriptionName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: The ID that uniquely identifies a subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
expand:
{
Description: Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges` ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a(n) BillingSubscription ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
beneficiary:
{
Description: The beneficiary of the billing subscription. ,
Required: False ,
}
{
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
objectId:
{
Description: The ID that uniquely identifies a user in a tenant. ,
Required: False ,
}
string ,
}
,
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
{
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. ,
Enum:
{
Active: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Deleted: No description available. ,
TransferredOut: No description available. ,
Transferring: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
lastMonthCharges:
{
Description: The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: Billing frequency of the product under the subscription. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
productCategory:
{
Description: The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. ,
Required: False ,
}
string ,
productType:
{
Description: Type of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: Purchase date of the product in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
renewalTermDetails:
{
Description: Details for the next renewal term of a subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
productId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Type Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. ,
Required: False ,
}
string ,
systemOverrides:
{
Description: System imposed policies that regulate behavior of the subscription. ,
Required: False ,
}
{
cancellation:
{
Description: The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed. ,
Enum:
{
NotAllowed: No description available. ,
Allowed: No description available. ,
}
,
Required: False ,
}
enum ,
cancellationAllowedEndDate:
{
Description: The end date in UTC time by when the self-serve cancellation ends. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resourceUri:
{
Description: Unique identifier of the linked resource. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
termStartDate:
{
Description: Start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningTenantId:
{
Description: The tenant in which the subscription is provisioned. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
operationStatus:
{
Description: The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
LockedForUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the subscription. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
suspensionReasonDetails:
{
Description: The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingSubscriptions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
includeDeleted:
{
Description: Can be used to get deleted billing subscriptions. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
expand:
{
Description: Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges` ,
Required: False ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a(n) BillingSubscription ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
beneficiary:
{
Description: The beneficiary of the billing subscription. ,
Required: False ,
}
{
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
objectId:
{
Description: The ID that uniquely identifies a user in a tenant. ,
Required: False ,
}
string ,
}
,
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
{
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. ,
Enum:
{
Active: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Deleted: No description available. ,
TransferredOut: No description available. ,
Transferring: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
lastMonthCharges:
{
Description: The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: Billing frequency of the product under the subscription. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
productCategory:
{
Description: The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. ,
Required: False ,
}
string ,
productType:
{
Description: Type of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: Purchase date of the product in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
renewalTermDetails:
{
Description: Details for the next renewal term of a subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
productId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Type Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. ,
Required: False ,
}
string ,
systemOverrides:
{
Description: System imposed policies that regulate behavior of the subscription. ,
Required: False ,
}
{
cancellation:
{
Description: The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed. ,
Enum:
{
NotAllowed: No description available. ,
Allowed: No description available. ,
}
,
Required: False ,
}
enum ,
cancellationAllowedEndDate:
{
Description: The end date in UTC time by when the self-serve cancellation ends. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resourceUri:
{
Description: Unique identifier of the linked resource. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
termStartDate:
{
Description: Start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningTenantId:
{
Description: The tenant in which the subscription is provisioned. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
operationStatus:
{
Description: The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
LockedForUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the subscription. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
suspensionReasonDetails:
{
Description: The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptions_ListByCustomer (removed)
Description :  Lists the subscriptions for a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/billingSubscriptions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
includeDeleted:
{
Description: Can be used to get deleted billing subscriptions. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
expand:
{
Description: Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges` ,
Required: False ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a(n) BillingSubscription ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
beneficiary:
{
Description: The beneficiary of the billing subscription. ,
Required: False ,
}
{
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
objectId:
{
Description: The ID that uniquely identifies a user in a tenant. ,
Required: False ,
}
string ,
}
,
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
{
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. ,
Enum:
{
Active: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Deleted: No description available. ,
TransferredOut: No description available. ,
Transferring: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
lastMonthCharges:
{
Description: The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: Billing frequency of the product under the subscription. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
productCategory:
{
Description: The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. ,
Required: False ,
}
string ,
productType:
{
Description: Type of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: Purchase date of the product in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
renewalTermDetails:
{
Description: Details for the next renewal term of a subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
productId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Type Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. ,
Required: False ,
}
string ,
systemOverrides:
{
Description: System imposed policies that regulate behavior of the subscription. ,
Required: False ,
}
{
cancellation:
{
Description: The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed. ,
Enum:
{
NotAllowed: No description available. ,
Allowed: No description available. ,
}
,
Required: False ,
}
enum ,
cancellationAllowedEndDate:
{
Description: The end date in UTC time by when the self-serve cancellation ends. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resourceUri:
{
Description: Unique identifier of the linked resource. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
termStartDate:
{
Description: Start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningTenantId:
{
Description: The tenant in which the subscription is provisioned. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
operationStatus:
{
Description: The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
LockedForUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the subscription. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
suspensionReasonDetails:
{
Description: The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingSubscriptions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
includeDeleted:
{
Description: Can be used to get deleted billing subscriptions. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
expand:
{
Description: Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges` ,
Required: False ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a(n) BillingSubscription ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
beneficiary:
{
Description: The beneficiary of the billing subscription. ,
Required: False ,
}
{
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
objectId:
{
Description: The ID that uniquely identifies a user in a tenant. ,
Required: False ,
}
string ,
}
,
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
{
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. ,
Enum:
{
Active: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Deleted: No description available. ,
TransferredOut: No description available. ,
Transferring: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
lastMonthCharges:
{
Description: The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: Billing frequency of the product under the subscription. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
productCategory:
{
Description: The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. ,
Required: False ,
}
string ,
productType:
{
Description: Type of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: Purchase date of the product in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
renewalTermDetails:
{
Description: Details for the next renewal term of a subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
productId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Type Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. ,
Required: False ,
}
string ,
systemOverrides:
{
Description: System imposed policies that regulate behavior of the subscription. ,
Required: False ,
}
{
cancellation:
{
Description: The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed. ,
Enum:
{
NotAllowed: No description available. ,
Allowed: No description available. ,
}
,
Required: False ,
}
enum ,
cancellationAllowedEndDate:
{
Description: The end date in UTC time by when the self-serve cancellation ends. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resourceUri:
{
Description: Unique identifier of the linked resource. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
termStartDate:
{
Description: Start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningTenantId:
{
Description: The tenant in which the subscription is provisioned. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
operationStatus:
{
Description: The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
LockedForUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the subscription. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
suspensionReasonDetails:
{
Description: The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptionsAliases_Get (removed)
Description :  Gets a subscription by its alias ID. The operation is supported for seat based billing subscriptions.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptionAliases/{aliasName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
aliasName:
{
Description: The ID that uniquely identifies a subscription alias. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a(n) BillingSubscriptionAlias ,
Required: False ,
}
{
billingSubscriptionId:
{
Description: The ID of the billing subscription with the subscription alias. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptionsAliases_CreateOrUpdate (removed)
Description :  Creates or updates a billing subscription by its alias ID. The operation is supported for seat based billing subscriptions.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptionAliases/{aliasName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
aliasName:
{
Description: The ID that uniquely identifies a subscription alias. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: A billing subscription alias. ,
Required: True ,
}
{
properties:
{
Description: The properties of a(n) BillingSubscriptionAlias ,
Required: False ,
}
{
billingSubscriptionId:
{
Description: The ID of the billing subscription with the subscription alias. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a(n) BillingSubscriptionAlias ,
Required: False ,
}
{
billingSubscriptionId:
{
Description: The ID of the billing subscription with the subscription alias. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a(n) BillingSubscriptionAlias ,
Required: False ,
}
{
billingSubscriptionId:
{
Description: The ID of the billing subscription with the subscription alias. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptionsAliases_ListByBillingAccount (removed)
Description :  Lists the subscription aliases for a billing account. The operation is supported for seat based billing subscriptions.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptionAliases
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
includeDeleted:
{
Description: Can be used to get deleted billing subscriptions. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a(n) BillingSubscriptionAlias ,
Required: False ,
}
{
billingSubscriptionId:
{
Description: The ID of the billing subscription with the subscription alias. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptions_Cancel (removed)
Description :  Cancels a usage-based subscription. This operation is supported only for billing accounts of type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}/cancel
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: The ID that uniquely identifies a subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters for cancel customer subscription. ,
Required: True ,
}
{
cancellationReason:
{
Description: Cancellation reason. ,
Enum:
{
Other: No description available. ,
Compromise: No description available. ,
Dispute: No description available. ,
}
,
Required: True ,
}
enum ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptions_Merge (removed)
Description :  Merges the billing subscription provided in the request with a target billing subscription.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}/merge
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: The ID that uniquely identifies a subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to merge the two billing subscriptions. ,
Required: True ,
}
{
targetBillingSubscriptionName:
{
Description: The ID of the target billing subscription that will be merged with the source subscription provided in the request. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of the source billing subscription that will be merged with the target billing subscription. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a(n) BillingSubscription ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
beneficiary:
{
Description: The beneficiary of the billing subscription. ,
Required: False ,
}
{
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
objectId:
{
Description: The ID that uniquely identifies a user in a tenant. ,
Required: False ,
}
string ,
}
,
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
{
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. ,
Enum:
{
Active: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Deleted: No description available. ,
TransferredOut: No description available. ,
Transferring: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
lastMonthCharges:
{
Description: The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: Billing frequency of the product under the subscription. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
productCategory:
{
Description: The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. ,
Required: False ,
}
string ,
productType:
{
Description: Type of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: Purchase date of the product in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
renewalTermDetails:
{
Description: Details for the next renewal term of a subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
productId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Type Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. ,
Required: False ,
}
string ,
systemOverrides:
{
Description: System imposed policies that regulate behavior of the subscription. ,
Required: False ,
}
{
cancellation:
{
Description: The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed. ,
Enum:
{
NotAllowed: No description available. ,
Allowed: No description available. ,
}
,
Required: False ,
}
enum ,
cancellationAllowedEndDate:
{
Description: The end date in UTC time by when the self-serve cancellation ends. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resourceUri:
{
Description: Unique identifier of the linked resource. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
termStartDate:
{
Description: Start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningTenantId:
{
Description: The tenant in which the subscription is provisioned. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
operationStatus:
{
Description: The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
LockedForUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the subscription. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
suspensionReasonDetails:
{
Description: The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptions_Move (removed)
Description :  Moves charges for a subscription to a new invoice section. The new invoice section must belong to the same billing profile as the existing invoice section. This operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}/move
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: The ID that uniquely identifies a subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters to transfer billing subscription. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: False ,
}
string ,
destinationEnrollmentAccountId:
{
Description: The destination enrollment account id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a(n) BillingSubscription ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
beneficiary:
{
Description: The beneficiary of the billing subscription. ,
Required: False ,
}
{
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
objectId:
{
Description: The ID that uniquely identifies a user in a tenant. ,
Required: False ,
}
string ,
}
,
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
{
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. ,
Enum:
{
Active: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Deleted: No description available. ,
TransferredOut: No description available. ,
Transferring: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
lastMonthCharges:
{
Description: The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: Billing frequency of the product under the subscription. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
productCategory:
{
Description: The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. ,
Required: False ,
}
string ,
productType:
{
Description: Type of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: Purchase date of the product in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
renewalTermDetails:
{
Description: Details for the next renewal term of a subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
productId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Type Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. ,
Required: False ,
}
string ,
systemOverrides:
{
Description: System imposed policies that regulate behavior of the subscription. ,
Required: False ,
}
{
cancellation:
{
Description: The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed. ,
Enum:
{
NotAllowed: No description available. ,
Allowed: No description available. ,
}
,
Required: False ,
}
enum ,
cancellationAllowedEndDate:
{
Description: The end date in UTC time by when the self-serve cancellation ends. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resourceUri:
{
Description: Unique identifier of the linked resource. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
termStartDate:
{
Description: Start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningTenantId:
{
Description: The tenant in which the subscription is provisioned. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
operationStatus:
{
Description: The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
LockedForUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the subscription. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
suspensionReasonDetails:
{
Description: The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptions_Split (removed)
Description :  Splits a subscription into a new subscription with quantity less than current subscription quantity and not equal to 0.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}/split
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: The ID that uniquely identifies a subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to split the billing subscription. ,
Required: True ,
}
{
targetProductTypeId:
{
Description: The ID of the target product to which the subscription needs to be split into. This value is not same as the value returned in Get API call and can be retrieved from Catalog API to know the product id to split into. ,
Required: False ,
}
string ,
targetSkuId:
{
Description: The ID of the target product to which the subscription needs to be split into. This value is not same as the value returned in Get API call and can be retrieved from Catalog API to know the sku id to split into. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of the target product to which the subscription needs to be split into. ,
Format: int32 ,
Required: False ,
}
integer ,
termDuration:
{
Description: The term duration of the target in ISO8601 format product to which the subscription needs to be split into. Example: P1M, P1Y ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The billing frequency of the target subscription in the ISO8601 format. Example: P1M, P3M, P1Y" ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a(n) BillingSubscription ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
beneficiary:
{
Description: The beneficiary of the billing subscription. ,
Required: False ,
}
{
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
objectId:
{
Description: The ID that uniquely identifies a user in a tenant. ,
Required: False ,
}
string ,
}
,
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
{
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. ,
Enum:
{
Active: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Deleted: No description available. ,
TransferredOut: No description available. ,
Transferring: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
lastMonthCharges:
{
Description: The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: Billing frequency of the product under the subscription. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
productCategory:
{
Description: The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. ,
Required: False ,
}
string ,
productType:
{
Description: Type of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: Purchase date of the product in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
renewalTermDetails:
{
Description: Details for the next renewal term of a subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
productId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Type Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. ,
Required: False ,
}
string ,
systemOverrides:
{
Description: System imposed policies that regulate behavior of the subscription. ,
Required: False ,
}
{
cancellation:
{
Description: The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed. ,
Enum:
{
NotAllowed: No description available. ,
Allowed: No description available. ,
}
,
Required: False ,
}
enum ,
cancellationAllowedEndDate:
{
Description: The end date in UTC time by when the self-serve cancellation ends. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resourceUri:
{
Description: Unique identifier of the linked resource. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
termStartDate:
{
Description: Start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningTenantId:
{
Description: The tenant in which the subscription is provisioned. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
operationStatus:
{
Description: The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
LockedForUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the subscription. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
suspensionReasonDetails:
{
Description: The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptions_ValidateMoveEligibility (removed)
Description :  Validates if charges for a subscription can be moved to a new invoice section. This operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}/validateMoveEligibility
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: The ID that uniquely identifies a subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters to transfer billing subscription. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: False ,
}
string ,
destinationEnrollmentAccountId:
{
Description: The destination enrollment account id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
isMoveEligible:
{
Description: Specifies whether the subscription is eligible to be transferred. ,
Required: False ,
}
boolean ,
errorDetails:
{
Description: Error details of the transfer eligibility validation. ,
Required: False ,
}
{
code:
{
Description: Error code of the transfer validation response. ,
Enum:
{
Other: No description available. ,
BillingAccountInactive: No description available. ,
DestinationBillingProfileInactive: No description available. ,
DestinationBillingProfileNotFound: No description available. ,
DestinationBillingProfilePastDue: No description available. ,
DestinationInvoiceSectionInactive: No description available. ,
DestinationInvoiceSectionNotFound: No description available. ,
InsufficientPermissionOnDestination: No description available. ,
InsufficientPermissionOnSource: No description available. ,
InvalidDestination: No description available. ,
InvalidSource: No description available. ,
MarketplaceNotEnabledOnDestination: No description available. ,
ProductInactive: No description available. ,
ProductNotFound: No description available. ,
ProductTypeNotSupported: No description available. ,
SourceBillingProfilePastDue: No description available. ,
SourceInvoiceSectionInactive: No description available. ,
AccountIsLocked: No description available. ,
AssetHasCap: No description available. ,
AssetNotActive: No description available. ,
BillingProfilePastDue: No description available. ,
CrossBillingAccountNotAllowed: No description available. ,
NoActiveAzurePlan: No description available. ,
None: No description available. ,
SubscriptionNotActive: No description available. ,
SubscriptionHasReservations: No description available. ,
SubscriptionTypeNotSupported: No description available. ,
InvoiceSectionIsRestricted: 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 error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptions_Delete (removed)
Description :  Cancels a billing subscription. This operation is supported only for billing accounts of type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptions_Get (removed)
Description :  Gets a subscription by its ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement, Microsoft Partner Agreement, and Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: The ID that uniquely identifies a subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
expand:
{
Description: Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges` ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a(n) BillingSubscription ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
beneficiary:
{
Description: The beneficiary of the billing subscription. ,
Required: False ,
}
{
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
objectId:
{
Description: The ID that uniquely identifies a user in a tenant. ,
Required: False ,
}
string ,
}
,
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
{
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. ,
Enum:
{
Active: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Deleted: No description available. ,
TransferredOut: No description available. ,
Transferring: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
lastMonthCharges:
{
Description: The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: Billing frequency of the product under the subscription. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
productCategory:
{
Description: The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. ,
Required: False ,
}
string ,
productType:
{
Description: Type of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: Purchase date of the product in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
renewalTermDetails:
{
Description: Details for the next renewal term of a subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
productId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Type Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. ,
Required: False ,
}
string ,
systemOverrides:
{
Description: System imposed policies that regulate behavior of the subscription. ,
Required: False ,
}
{
cancellation:
{
Description: The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed. ,
Enum:
{
NotAllowed: No description available. ,
Allowed: No description available. ,
}
,
Required: False ,
}
enum ,
cancellationAllowedEndDate:
{
Description: The end date in UTC time by when the self-serve cancellation ends. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resourceUri:
{
Description: Unique identifier of the linked resource. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
termStartDate:
{
Description: Start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningTenantId:
{
Description: The tenant in which the subscription is provisioned. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
operationStatus:
{
Description: The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
LockedForUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the subscription. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
suspensionReasonDetails:
{
Description: The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptions_Update (removed)
Description :  Updates the properties of a billing subscription.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: The ID that uniquely identifies a subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The billing properties of a subscription. ,
Required: True ,
}
{
properties:
{
Description: The properties of a(n) BillingSubscription ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
beneficiary:
{
Description: The beneficiary of the billing subscription. ,
Required: False ,
}
{
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
objectId:
{
Description: The ID that uniquely identifies a user in a tenant. ,
Required: False ,
}
string ,
}
,
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
{
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. ,
Enum:
{
Active: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Deleted: No description available. ,
TransferredOut: No description available. ,
Transferring: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
lastMonthCharges:
{
Description: The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: Billing frequency of the product under the subscription. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
productCategory:
{
Description: The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. ,
Required: False ,
}
string ,
productType:
{
Description: Type of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: Purchase date of the product in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
renewalTermDetails:
{
Description: Details for the next renewal term of a subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
productId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Type Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. ,
Required: False ,
}
string ,
systemOverrides:
{
Description: System imposed policies that regulate behavior of the subscription. ,
Required: False ,
}
{
cancellation:
{
Description: The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed. ,
Enum:
{
NotAllowed: No description available. ,
Allowed: No description available. ,
}
,
Required: False ,
}
enum ,
cancellationAllowedEndDate:
{
Description: The end date in UTC time by when the self-serve cancellation ends. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resourceUri:
{
Description: Unique identifier of the linked resource. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
termStartDate:
{
Description: Start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningTenantId:
{
Description: The tenant in which the subscription is provisioned. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
operationStatus:
{
Description: The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
LockedForUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the subscription. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
suspensionReasonDetails:
{
Description: The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a(n) BillingSubscription ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
beneficiary:
{
Description: The beneficiary of the billing subscription. ,
Required: False ,
}
{
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
objectId:
{
Description: The ID that uniquely identifies a user in a tenant. ,
Required: False ,
}
string ,
}
,
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
{
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. ,
Enum:
{
Active: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Deleted: No description available. ,
TransferredOut: No description available. ,
Transferring: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
lastMonthCharges:
{
Description: The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: Billing frequency of the product under the subscription. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
productCategory:
{
Description: The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. ,
Required: False ,
}
string ,
productType:
{
Description: Type of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: Purchase date of the product in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
renewalTermDetails:
{
Description: Details for the next renewal term of a subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
productId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Type Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. ,
Required: False ,
}
string ,
systemOverrides:
{
Description: System imposed policies that regulate behavior of the subscription. ,
Required: False ,
}
{
cancellation:
{
Description: The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed. ,
Enum:
{
NotAllowed: No description available. ,
Allowed: No description available. ,
}
,
Required: False ,
}
enum ,
cancellationAllowedEndDate:
{
Description: The end date in UTC time by when the self-serve cancellation ends. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resourceUri:
{
Description: Unique identifier of the linked resource. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
termStartDate:
{
Description: Start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningTenantId:
{
Description: The tenant in which the subscription is provisioned. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
operationStatus:
{
Description: The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
LockedForUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the subscription. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
suspensionReasonDetails:
{
Description: The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptions_ListByBillingAccount (removed)
Description :  Lists the subscriptions for a billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
includeDeleted:
{
Description: Can be used to get deleted billing subscriptions. ,
Required: False ,
}
boolean ,
includeTenantSubscriptions:
{
Description: Can be used to get tenant-owned billing subscriptions. This field is only applies to Microsoft Online Services Program billing accounts. ,
Required: False ,
}
boolean ,
includeFailed:
{
Description: Can be used to get failed billing subscriptions. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
expand:
{
Description: Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges` ,
Required: False ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a(n) BillingSubscription ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
beneficiary:
{
Description: The beneficiary of the billing subscription. ,
Required: False ,
}
{
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
objectId:
{
Description: The ID that uniquely identifies a user in a tenant. ,
Required: False ,
}
string ,
}
,
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
{
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. ,
Enum:
{
Active: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Deleted: No description available. ,
TransferredOut: No description available. ,
Transferring: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
lastMonthCharges:
{
Description: The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: Billing frequency of the product under the subscription. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
productCategory:
{
Description: The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. ,
Required: False ,
}
string ,
productType:
{
Description: Type of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: Purchase date of the product in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
renewalTermDetails:
{
Description: Details for the next renewal term of a subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
productId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Type Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. ,
Required: False ,
}
string ,
systemOverrides:
{
Description: System imposed policies that regulate behavior of the subscription. ,
Required: False ,
}
{
cancellation:
{
Description: The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed. ,
Enum:
{
NotAllowed: No description available. ,
Allowed: No description available. ,
}
,
Required: False ,
}
enum ,
cancellationAllowedEndDate:
{
Description: The end date in UTC time by when the self-serve cancellation ends. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resourceUri:
{
Description: Unique identifier of the linked resource. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
termStartDate:
{
Description: Start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningTenantId:
{
Description: The tenant in which the subscription is provisioned. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
operationStatus:
{
Description: The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
LockedForUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the subscription. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
suspensionReasonDetails:
{
Description: The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptions_ListByCustomerAtBillingAccount (removed)
Description :  Lists the subscriptions for a customer at billing account level. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/billingSubscriptions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
includeDeleted:
{
Description: Can be used to get deleted billing subscriptions. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
expand:
{
Description: Can be used to expand `Reseller`, `ConsumptionCostCenter`, `LastMonthCharges` and `MonthToDateCharges` ,
Required: False ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a(n) BillingSubscription ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
beneficiary:
{
Description: The beneficiary of the billing subscription. ,
Required: False ,
}
{
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
objectId:
{
Description: The ID that uniquely identifies a user in a tenant. ,
Required: False ,
}
string ,
}
,
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
{
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. ,
Enum:
{
Active: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Deleted: No description available. ,
TransferredOut: No description available. ,
Transferring: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
lastMonthCharges:
{
Description: The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: Billing frequency of the product under the subscription. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
productCategory:
{
Description: The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. ,
Required: False ,
}
string ,
productType:
{
Description: Type of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: Purchase date of the product in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
renewalTermDetails:
{
Description: Details for the next renewal term of a subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
productId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Type Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. ,
Required: False ,
}
string ,
systemOverrides:
{
Description: System imposed policies that regulate behavior of the subscription. ,
Required: False ,
}
{
cancellation:
{
Description: The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed. ,
Enum:
{
NotAllowed: No description available. ,
Allowed: No description available. ,
}
,
Required: False ,
}
enum ,
cancellationAllowedEndDate:
{
Description: The end date in UTC time by when the self-serve cancellation ends. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resourceUri:
{
Description: Unique identifier of the linked resource. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
termStartDate:
{
Description: Start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningTenantId:
{
Description: The tenant in which the subscription is provisioned. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
operationStatus:
{
Description: The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
LockedForUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the subscription. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
suspensionReasonDetails:
{
Description: The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingSubscriptions_ListByEnrollmentAccount (removed)
Description :  Lists the subscriptions for an enrollment account. The operation is supported for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingSubscriptions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
enrollmentAccountName:
{
Description: The name of the enrollment account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a(n) BillingSubscription ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
beneficiary:
{
Description: The beneficiary of the billing subscription. ,
Required: False ,
}
{
tenantId:
{
Description: The ID that uniquely identifies a tenant. ,
Required: False ,
}
string ,
objectId:
{
Description: The ID that uniquely identifies a user in a tenant. ,
Required: False ,
}
string ,
}
,
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the billing subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts. ,
Required: False ,
}
{
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type. ,
Enum:
{
Active: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Deleted: No description available. ,
TransferredOut: No description available. ,
Transferring: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
lastMonthCharges:
{
Description: The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: The amount value. For example, if the currency is USD, then a value of 600 would be $600.00. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: Billing frequency of the product under the subscription. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
productCategory:
{
Description: The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. ,
Required: False ,
}
string ,
productType:
{
Description: Type of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: Purchase date of the product in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
renewalTermDetails:
{
Description: Details for the next renewal term of a subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
productId:
{
Description: Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
productTypeId:
{
Description: Type Id of the product for which the subscription is purchased. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity of licenses or fulfillment units for the subscription. ,
Format: int64 ,
Required: False ,
}
integer ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. ,
Required: False ,
}
string ,
systemOverrides:
{
Description: System imposed policies that regulate behavior of the subscription. ,
Required: False ,
}
{
cancellation:
{
Description: The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed. ,
Enum:
{
NotAllowed: No description available. ,
Allowed: No description available. ,
}
,
Required: False ,
}
enum ,
cancellationAllowedEndDate:
{
Description: The end date in UTC time by when the self-serve cancellation ends. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
resourceUri:
{
Description: Unique identifier of the linked resource. ,
Required: False ,
}
string ,
termDuration:
{
Description: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
termStartDate:
{
Description: Start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: End date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningTenantId:
{
Description: The tenant in which the subscription is provisioned. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts ,
Enum:
{
Other: No description available. ,
Unknown: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Warned: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Cancelled: No description available. ,
Suspended: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
operationStatus:
{
Description: The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
LockedForUpdate: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the subscription. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
suspensionReasonDetails:
{
Description: The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
{
effectiveDate:
{
Description: The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
None: No description available. ,
Cancelled: No description available. ,
PastDue: No description available. ,
SuspiciousActivity: No description available. ,
Other: No description available. ,
Transferred: No description available. ,
PolicyViolation: No description available. ,
SpendingLimitReached: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Customers_Get (removed)
Description :  Gets a customer by its ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: A partner's customer. ,
Required: False ,
}
{
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
systemId:
{
Description: The system generated unique identifier for a customer. ,
Required: False ,
}
string ,
status:
{
Description: Identifies the status of an customer. This is an upcoming property that will be populated in the future. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
enabledAzurePlans:
{
Description: Azure plans enabled for the customer. ,
Required: False ,
}
[
{
productId:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
skuId:
{
Description: The ID that uniquely identifies a sku. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
resellers:
{
Description: The list of resellers for which an Azure plan is enabled for the customer. ,
Required: False ,
}
[
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
]
,
tags:
{
Description: Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
expand:
{
Description: May be used to expand enabledAzurePlans and resellers ,
Required: False ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A partner's customer. ,
Required: False ,
}
{
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
systemId:
{
Description: The system generated unique identifier for a customer. ,
Required: False ,
}
string ,
status:
{
Description: Identifies the status of an customer. This is an upcoming property that will be populated in the future. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
enabledAzurePlans:
{
Description: Azure plans enabled for the customer. ,
Required: False ,
}
[
{
productId:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
skuId:
{
Description: The ID that uniquely identifies a sku. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
resellers:
{
Description: The list of resellers for which an Azure plan is enabled for the customer. ,
Required: False ,
}
[
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
]
,
tags:
{
Description: Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Customers_GetByBillingAccount (removed)
Description :  Gets a customer by its ID at billing account level. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: A partner's customer. ,
Required: False ,
}
{
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
systemId:
{
Description: The system generated unique identifier for a customer. ,
Required: False ,
}
string ,
status:
{
Description: Identifies the status of an customer. This is an upcoming property that will be populated in the future. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
enabledAzurePlans:
{
Description: Azure plans enabled for the customer. ,
Required: False ,
}
[
{
productId:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
skuId:
{
Description: The ID that uniquely identifies a sku. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
resellers:
{
Description: The list of resellers for which an Azure plan is enabled for the customer. ,
Required: False ,
}
[
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
]
,
tags:
{
Description: Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
expand:
{
Description: May be used to expand enabledAzurePlans and resellers ,
Required: False ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A partner's customer. ,
Required: False ,
}
{
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
systemId:
{
Description: The system generated unique identifier for a customer. ,
Required: False ,
}
string ,
status:
{
Description: Identifies the status of an customer. This is an upcoming property that will be populated in the future. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
Deleted: No description available. ,
UnderReview: No description available. ,
}
,
Required: False ,
}
enum ,
enabledAzurePlans:
{
Description: Azure plans enabled for the customer. ,
Required: False ,
}
[
{
productId:
{
Description: The ID that uniquely identifies a product. ,
Required: False ,
}
string ,
skuId:
{
Description: The ID that uniquely identifies a sku. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
resellers:
{
Description: The list of resellers for which an Azure plan is enabled for the customer. ,
Required: False ,
}
[
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
]
,
tags:
{
Description: Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Departments_Get (removed)
Description :  Gets a department by ID. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Optional grouping of enrollment accounts to segment costs into logical groupings and set budgets. ,
Required: False ,
}
{
costCenter:
{
Description: The cost center associated with the department. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the department. ,
Required: False ,
}
string ,
id:
{
Description: The ID that uniquely identifies the department. ,
Required: False ,
}
string ,
status:
{
Description: The status of the department. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Departments_ListByBillingAccount (removed)
Description :  Lists the departments that a user has access to. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: Optional grouping of enrollment accounts to segment costs into logical groupings and set budgets. ,
Required: False ,
}
{
costCenter:
{
Description: The cost center associated with the department. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the department. ,
Required: False ,
}
string ,
id:
{
Description: The ID that uniquely identifies the department. ,
Required: False ,
}
string ,
status:
{
Description: The status of the department. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EnrollmentAccounts_GetByDepartment (removed)
Description :  Gets an enrollment account by department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: It is an organizational hierarchy within a billing account to administer and manage azure costs. ,
Required: False ,
}
{
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
departmentDisplayName:
{
Description: The name of the department under which the enrollment account exists. ,
Required: False ,
}
string ,
departmentId:
{
Description: The ID that uniquely identifies the department. ,
Required: False ,
}
string ,
isDevTestEnabled:
{
Description: Boolean flag which enables subscribers to run development and testing workloads on Azure at special Dev/Test rates. ,
Required: False ,
}
boolean ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
authType:
{
Description: The authorization type of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The date from which the enrollment account became valid and functional. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date of expiration of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EnrollmentAccounts_ListByDepartment (removed)
Description :  Lists the enrollment accounts for a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/enrollmentAccounts
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
departmentName:
{
Description: The name of the department. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: It is an organizational hierarchy within a billing account to administer and manage azure costs. ,
Required: False ,
}
{
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
departmentDisplayName:
{
Description: The name of the department under which the enrollment account exists. ,
Required: False ,
}
string ,
departmentId:
{
Description: The ID that uniquely identifies the department. ,
Required: False ,
}
string ,
isDevTestEnabled:
{
Description: Boolean flag which enables subscribers to run development and testing workloads on Azure at special Dev/Test rates. ,
Required: False ,
}
boolean ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
authType:
{
Description: The authorization type of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The date from which the enrollment account became valid and functional. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date of expiration of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EnrollmentAccounts_Get (removed)
Description :  Gets an enrollment account by ID. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: It is an organizational hierarchy within a billing account to administer and manage azure costs. ,
Required: False ,
}
{
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
departmentDisplayName:
{
Description: The name of the department under which the enrollment account exists. ,
Required: False ,
}
string ,
departmentId:
{
Description: The ID that uniquely identifies the department. ,
Required: False ,
}
string ,
isDevTestEnabled:
{
Description: Boolean flag which enables subscribers to run development and testing workloads on Azure at special Dev/Test rates. ,
Required: False ,
}
boolean ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
authType:
{
Description: The authorization type of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The date from which the enrollment account became valid and functional. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date of expiration of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EnrollmentAccounts_ListByBillingAccount (removed)
Description :  Lists the enrollment accounts for a billing account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: It is an organizational hierarchy within a billing account to administer and manage azure costs. ,
Required: False ,
}
{
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
departmentDisplayName:
{
Description: The name of the department under which the enrollment account exists. ,
Required: False ,
}
string ,
departmentId:
{
Description: The ID that uniquely identifies the department. ,
Required: False ,
}
string ,
isDevTestEnabled:
{
Description: Boolean flag which enables subscribers to run development and testing workloads on Azure at special Dev/Test rates. ,
Required: False ,
}
boolean ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
authType:
{
Description: The authorization type of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The date from which the enrollment account became valid and functional. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The date of expiration of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date ,
Required: False ,
}
string ,
periodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: An invoice. ,
Required: False ,
}
{
amountDue:
{
Description: The amount due as of now. ,
Required: False ,
}
string ,
azurePrepaymentApplied:
{
Description: The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
billedAmount:
{
Description: The total charges for the invoice billing period. ,
Required: False ,
}
string ,
billedDocumentId:
{
Description: The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
creditAmount:
{
Description: The total refund for returns and cancellations during the invoice billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
creditForDocumentId:
{
Description: The Id of the invoice which got voided and this credit note was issued as a result. This field is applicable to the credit notes only. ,
Required: False ,
}
string ,
documents:
{
Description: List of documents available to download and view such as invoice, credit note, or tax receipt. ,
Required: False ,
}
[
{
documentNumbers:
{
Description: The document numbers for the invoice document. ,
Required: False ,
}
[
string ,
]
,
externalUrl:
{
Description: The URL to download the invoice document if the source is external to Microsoft.Billing. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the document. ,
Enum:
{
Other: No description available. ,
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
Summary: No description available. ,
Transactions: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The ID that uniquely identifies an invoice document. This ID may be an identifier for an invoice PDF, a credit note, or a tax receipt. ,
Required: False ,
}
string ,
url:
{
Description: The URL to download the invoice document if the source is internal to Microsoft.Billing. ,
Required: False ,
}
string ,
source:
{
Description: The source of the document. ENF for Brazil and DRS for rest of the world. ,
Enum:
{
Other: No description available. ,
DRS: No description available. ,
ENF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
documentType:
{
Description: The type of the document. ,
Enum:
{
Other: No description available. ,
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
Summary: No description available. ,
Transactions: No description available. ,
}
,
Required: False ,
}
enum ,
dueDate:
{
Description: The due date for the invoice. ,
Format: date-time ,
Required: False ,
}
string ,
failedPayments:
{
Description: List of failed payments. ,
Required: False ,
}
[
{
date:
{
Description: The date when the payment was attempted. ,
Format: date-time ,
Required: False ,
}
string ,
failedPaymentReason:
{
Description: The reason that the payment failed. ,
Enum:
{
Other: No description available. ,
BankDeclined: No description available. ,
CardExpired: No description available. ,
IncorrectCardDetails: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
freeAzureCreditApplied:
{
Description: The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when the invoice was generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceType:
{
Description: Invoice type. ,
Enum:
{
Other: No description available. ,
AzureServices: No description available. ,
AzureMarketplace: No description available. ,
AzureSupport: No description available. ,
}
,
Required: False ,
}
enum ,
isMonthlyInvoice:
{
Description: Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
boolean ,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
amount:
{
Description: The paid amount. ,
Required: False ,
}
string ,
date:
{
Description: The date when the payment was made. ,
Format: date-time ,
Required: False ,
}
string ,
paymentMethodId:
{
Description: The ID that uniquely identifies the payment method used for the invoice. ,
Required: False ,
}
string ,
paymentMethodFamily:
{
Description: The family of payment method. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
}
,
]
,
purchaseOrderNumber:
{
Description: An optional purchase order number for the invoice. ,
Required: False ,
}
string ,
rebillDetails:
{
Description: Rebill details for an invoice. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the invoice. ,
Enum:
{
Other: No description available. ,
Due: No description available. ,
OverDue: No description available. ,
Paid: No description available. ,
Void: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionDisplayName:
{
Description: The name of the billing subscription for which the invoice is generated. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
Required: False ,
}
string ,
specialTaxationType:
{
Description: Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic. ,
Enum:
{
SubtotalLevel: No description available. ,
InvoiceLevel: No description available. ,
}
,
Required: False ,
}
enum ,
subTotal:
{
Description: The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
taxAmount:
{
Description: The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
totalAmount:
{
Description: The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
refundDetails:
{
Description: The details of a refund request. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Invoices_DownloadDocumentsByBillingAccount (removed)
Description :  Gets a URL to download multiple invoice documents (invoice pdf, tax receipts, credit notes) as a zip file. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/downloadDocuments
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: A list of download details for individual documents. ,
Required: True ,
}
{
documentName:
{
Description: The ID that uniquely identifies an invoice document. This ID may be an identifier for an invoice PDF, a credit note, or a tax receipt. If omitted, the most recent invoice PDF for the invoice will be returned. ,
Required: False ,
}
string ,
invoiceName:
{
Description: The ID that uniquely identifies an invoice. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

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

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Invoices_Amend (removed)
Description :  Regenerate an invoice by billing account name and invoice name. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Invoices_DownloadByBillingAccount (removed)
Description :  Gets a URL to download an invoice document. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/download
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
invoiceName:
{
Description: The ID that uniquely identifies an invoice. ,
Required: True ,
}
string ,
documentName:
{
Description: The ID that uniquely identifies an invoice document. This ID may be an identifier for an invoice PDF, a credit note, or a tax receipt. ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Invoices_DownloadSummaryByBillingAccount (removed)
Description :  Gets a URL to download the summary document for an invoice. The operation is supported for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Invoices_GetByBillingAccount (removed)
Description :  Gets an invoice by billing account name and ID. The operation is supported for all billing account types.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: An invoice. ,
Required: False ,
}
{
amountDue:
{
Description: The amount due as of now. ,
Required: False ,
}
string ,
azurePrepaymentApplied:
{
Description: The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
billedAmount:
{
Description: The total charges for the invoice billing period. ,
Required: False ,
}
string ,
billedDocumentId:
{
Description: The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
creditAmount:
{
Description: The total refund for returns and cancellations during the invoice billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
creditForDocumentId:
{
Description: The Id of the invoice which got voided and this credit note was issued as a result. This field is applicable to the credit notes only. ,
Required: False ,
}
string ,
documents:
{
Description: List of documents available to download and view such as invoice, credit note, or tax receipt. ,
Required: False ,
}
[
{
documentNumbers:
{
Description: The document numbers for the invoice document. ,
Required: False ,
}
[
string ,
]
,
externalUrl:
{
Description: The URL to download the invoice document if the source is external to Microsoft.Billing. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the document. ,
Enum:
{
Other: No description available. ,
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
Summary: No description available. ,
Transactions: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The ID that uniquely identifies an invoice document. This ID may be an identifier for an invoice PDF, a credit note, or a tax receipt. ,
Required: False ,
}
string ,
url:
{
Description: The URL to download the invoice document if the source is internal to Microsoft.Billing. ,
Required: False ,
}
string ,
source:
{
Description: The source of the document. ENF for Brazil and DRS for rest of the world. ,
Enum:
{
Other: No description available. ,
DRS: No description available. ,
ENF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
documentType:
{
Description: The type of the document. ,
Enum:
{
Other: No description available. ,
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
Summary: No description available. ,
Transactions: No description available. ,
}
,
Required: False ,
}
enum ,
dueDate:
{
Description: The due date for the invoice. ,
Format: date-time ,
Required: False ,
}
string ,
failedPayments:
{
Description: List of failed payments. ,
Required: False ,
}
[
{
date:
{
Description: The date when the payment was attempted. ,
Format: date-time ,
Required: False ,
}
string ,
failedPaymentReason:
{
Description: The reason that the payment failed. ,
Enum:
{
Other: No description available. ,
BankDeclined: No description available. ,
CardExpired: No description available. ,
IncorrectCardDetails: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
freeAzureCreditApplied:
{
Description: The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when the invoice was generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceType:
{
Description: Invoice type. ,
Enum:
{
Other: No description available. ,
AzureServices: No description available. ,
AzureMarketplace: No description available. ,
AzureSupport: No description available. ,
}
,
Required: False ,
}
enum ,
isMonthlyInvoice:
{
Description: Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
boolean ,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
amount:
{
Description: The paid amount. ,
Required: False ,
}
string ,
date:
{
Description: The date when the payment was made. ,
Format: date-time ,
Required: False ,
}
string ,
paymentMethodId:
{
Description: The ID that uniquely identifies the payment method used for the invoice. ,
Required: False ,
}
string ,
paymentMethodFamily:
{
Description: The family of payment method. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
}
,
]
,
purchaseOrderNumber:
{
Description: An optional purchase order number for the invoice. ,
Required: False ,
}
string ,
rebillDetails:
{
Description: Rebill details for an invoice. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the invoice. ,
Enum:
{
Other: No description available. ,
Due: No description available. ,
OverDue: No description available. ,
Paid: No description available. ,
Void: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionDisplayName:
{
Description: The name of the billing subscription for which the invoice is generated. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
Required: False ,
}
string ,
specialTaxationType:
{
Description: Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic. ,
Enum:
{
SubtotalLevel: No description available. ,
InvoiceLevel: No description available. ,
}
,
Required: False ,
}
enum ,
subTotal:
{
Description: The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
taxAmount:
{
Description: The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
totalAmount:
{
Description: The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
refundDetails:
{
Description: The details of a refund request. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Invoices_ListByBillingAccount (removed)
Description :  Lists the invoices for a billing account for a given start date and end date. The operation is supported for all billing account types.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date ,
Required: False ,
}
string ,
periodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: An invoice. ,
Required: False ,
}
{
amountDue:
{
Description: The amount due as of now. ,
Required: False ,
}
string ,
azurePrepaymentApplied:
{
Description: The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
billedAmount:
{
Description: The total charges for the invoice billing period. ,
Required: False ,
}
string ,
billedDocumentId:
{
Description: The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
creditAmount:
{
Description: The total refund for returns and cancellations during the invoice billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
creditForDocumentId:
{
Description: The Id of the invoice which got voided and this credit note was issued as a result. This field is applicable to the credit notes only. ,
Required: False ,
}
string ,
documents:
{
Description: List of documents available to download and view such as invoice, credit note, or tax receipt. ,
Required: False ,
}
[
{
documentNumbers:
{
Description: The document numbers for the invoice document. ,
Required: False ,
}
[
string ,
]
,
externalUrl:
{
Description: The URL to download the invoice document if the source is external to Microsoft.Billing. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the document. ,
Enum:
{
Other: No description available. ,
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
Summary: No description available. ,
Transactions: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The ID that uniquely identifies an invoice document. This ID may be an identifier for an invoice PDF, a credit note, or a tax receipt. ,
Required: False ,
}
string ,
url:
{
Description: The URL to download the invoice document if the source is internal to Microsoft.Billing. ,
Required: False ,
}
string ,
source:
{
Description: The source of the document. ENF for Brazil and DRS for rest of the world. ,
Enum:
{
Other: No description available. ,
DRS: No description available. ,
ENF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
documentType:
{
Description: The type of the document. ,
Enum:
{
Other: No description available. ,
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
Summary: No description available. ,
Transactions: No description available. ,
}
,
Required: False ,
}
enum ,
dueDate:
{
Description: The due date for the invoice. ,
Format: date-time ,
Required: False ,
}
string ,
failedPayments:
{
Description: List of failed payments. ,
Required: False ,
}
[
{
date:
{
Description: The date when the payment was attempted. ,
Format: date-time ,
Required: False ,
}
string ,
failedPaymentReason:
{
Description: The reason that the payment failed. ,
Enum:
{
Other: No description available. ,
BankDeclined: No description available. ,
CardExpired: No description available. ,
IncorrectCardDetails: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
freeAzureCreditApplied:
{
Description: The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when the invoice was generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceType:
{
Description: Invoice type. ,
Enum:
{
Other: No description available. ,
AzureServices: No description available. ,
AzureMarketplace: No description available. ,
AzureSupport: No description available. ,
}
,
Required: False ,
}
enum ,
isMonthlyInvoice:
{
Description: Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
boolean ,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
amount:
{
Description: The paid amount. ,
Required: False ,
}
string ,
date:
{
Description: The date when the payment was made. ,
Format: date-time ,
Required: False ,
}
string ,
paymentMethodId:
{
Description: The ID that uniquely identifies the payment method used for the invoice. ,
Required: False ,
}
string ,
paymentMethodFamily:
{
Description: The family of payment method. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
}
,
]
,
purchaseOrderNumber:
{
Description: An optional purchase order number for the invoice. ,
Required: False ,
}
string ,
rebillDetails:
{
Description: Rebill details for an invoice. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the invoice. ,
Enum:
{
Other: No description available. ,
Due: No description available. ,
OverDue: No description available. ,
Paid: No description available. ,
Void: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionDisplayName:
{
Description: The name of the billing subscription for which the invoice is generated. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
Required: False ,
}
string ,
specialTaxationType:
{
Description: Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic. ,
Enum:
{
SubtotalLevel: No description available. ,
InvoiceLevel: No description available. ,
}
,
Required: False ,
}
enum ,
subTotal:
{
Description: The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
taxAmount:
{
Description: The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
totalAmount:
{
Description: The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
refundDetails:
{
Description: The details of a refund request. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Invoices_DownloadDocumentsByBillingSubscription (removed)
Description :  Gets a URL to download multiple invoice documents (invoice pdf, tax receipts, credit notes) as a zip file. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/downloadDocuments
{
subscriptionId:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: A list of download details for individual documents. ,
Required: True ,
}
{
documentName:
{
Description: The ID that uniquely identifies an invoice document. This ID may be an identifier for an invoice PDF, a credit note, or a tax receipt. If omitted, the most recent invoice PDF for the invoice will be returned. ,
Required: False ,
}
string ,
invoiceName:
{
Description: The ID that uniquely identifies an invoice. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

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

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Invoices_DownloadByBillingSubscription (removed)
Description :  Gets a URL to download an invoice by billing subscription. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices/{invoiceName}/download
{
subscriptionId:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: True ,
}
string ,
invoiceName:
{
Description: The ID that uniquely identifies an invoice. ,
Required: True ,
}
string ,
documentName:
{
Description: The ID that uniquely identifies an invoice document. This ID may be an identifier for an invoice PDF, a credit note, or a tax receipt. ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Invoices_GetByBillingSubscription (removed)
Description :  Gets an invoice by subscription ID and invoice ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: An invoice. ,
Required: False ,
}
{
amountDue:
{
Description: The amount due as of now. ,
Required: False ,
}
string ,
azurePrepaymentApplied:
{
Description: The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
billedAmount:
{
Description: The total charges for the invoice billing period. ,
Required: False ,
}
string ,
billedDocumentId:
{
Description: The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
creditAmount:
{
Description: The total refund for returns and cancellations during the invoice billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
creditForDocumentId:
{
Description: The Id of the invoice which got voided and this credit note was issued as a result. This field is applicable to the credit notes only. ,
Required: False ,
}
string ,
documents:
{
Description: List of documents available to download and view such as invoice, credit note, or tax receipt. ,
Required: False ,
}
[
{
documentNumbers:
{
Description: The document numbers for the invoice document. ,
Required: False ,
}
[
string ,
]
,
externalUrl:
{
Description: The URL to download the invoice document if the source is external to Microsoft.Billing. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the document. ,
Enum:
{
Other: No description available. ,
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
Summary: No description available. ,
Transactions: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The ID that uniquely identifies an invoice document. This ID may be an identifier for an invoice PDF, a credit note, or a tax receipt. ,
Required: False ,
}
string ,
url:
{
Description: The URL to download the invoice document if the source is internal to Microsoft.Billing. ,
Required: False ,
}
string ,
source:
{
Description: The source of the document. ENF for Brazil and DRS for rest of the world. ,
Enum:
{
Other: No description available. ,
DRS: No description available. ,
ENF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
documentType:
{
Description: The type of the document. ,
Enum:
{
Other: No description available. ,
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
Summary: No description available. ,
Transactions: No description available. ,
}
,
Required: False ,
}
enum ,
dueDate:
{
Description: The due date for the invoice. ,
Format: date-time ,
Required: False ,
}
string ,
failedPayments:
{
Description: List of failed payments. ,
Required: False ,
}
[
{
date:
{
Description: The date when the payment was attempted. ,
Format: date-time ,
Required: False ,
}
string ,
failedPaymentReason:
{
Description: The reason that the payment failed. ,
Enum:
{
Other: No description available. ,
BankDeclined: No description available. ,
CardExpired: No description available. ,
IncorrectCardDetails: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
freeAzureCreditApplied:
{
Description: The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when the invoice was generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceType:
{
Description: Invoice type. ,
Enum:
{
Other: No description available. ,
AzureServices: No description available. ,
AzureMarketplace: No description available. ,
AzureSupport: No description available. ,
}
,
Required: False ,
}
enum ,
isMonthlyInvoice:
{
Description: Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
boolean ,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
amount:
{
Description: The paid amount. ,
Required: False ,
}
string ,
date:
{
Description: The date when the payment was made. ,
Format: date-time ,
Required: False ,
}
string ,
paymentMethodId:
{
Description: The ID that uniquely identifies the payment method used for the invoice. ,
Required: False ,
}
string ,
paymentMethodFamily:
{
Description: The family of payment method. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
}
,
]
,
purchaseOrderNumber:
{
Description: An optional purchase order number for the invoice. ,
Required: False ,
}
string ,
rebillDetails:
{
Description: Rebill details for an invoice. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the invoice. ,
Enum:
{
Other: No description available. ,
Due: No description available. ,
OverDue: No description available. ,
Paid: No description available. ,
Void: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionDisplayName:
{
Description: The name of the billing subscription for which the invoice is generated. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
Required: False ,
}
string ,
specialTaxationType:
{
Description: Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic. ,
Enum:
{
SubtotalLevel: No description available. ,
InvoiceLevel: No description available. ,
}
,
Required: False ,
}
enum ,
subTotal:
{
Description: The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
taxAmount:
{
Description: The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
totalAmount:
{
Description: The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
refundDetails:
{
Description: The details of a refund request. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Invoices_ListByBillingSubscription (removed)
Description :  Lists the invoices for a subscription. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices
{
subscriptionId:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date ,
Required: False ,
}
string ,
periodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date ,
Required: False ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: An invoice. ,
Required: False ,
}
{
amountDue:
{
Description: The amount due as of now. ,
Required: False ,
}
string ,
azurePrepaymentApplied:
{
Description: The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
billedAmount:
{
Description: The total charges for the invoice billing period. ,
Required: False ,
}
string ,
billedDocumentId:
{
Description: The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
creditAmount:
{
Description: The total refund for returns and cancellations during the invoice billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
creditForDocumentId:
{
Description: The Id of the invoice which got voided and this credit note was issued as a result. This field is applicable to the credit notes only. ,
Required: False ,
}
string ,
documents:
{
Description: List of documents available to download and view such as invoice, credit note, or tax receipt. ,
Required: False ,
}
[
{
documentNumbers:
{
Description: The document numbers for the invoice document. ,
Required: False ,
}
[
string ,
]
,
externalUrl:
{
Description: The URL to download the invoice document if the source is external to Microsoft.Billing. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the document. ,
Enum:
{
Other: No description available. ,
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
Summary: No description available. ,
Transactions: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The ID that uniquely identifies an invoice document. This ID may be an identifier for an invoice PDF, a credit note, or a tax receipt. ,
Required: False ,
}
string ,
url:
{
Description: The URL to download the invoice document if the source is internal to Microsoft.Billing. ,
Required: False ,
}
string ,
source:
{
Description: The source of the document. ENF for Brazil and DRS for rest of the world. ,
Enum:
{
Other: No description available. ,
DRS: No description available. ,
ENF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
documentType:
{
Description: The type of the document. ,
Enum:
{
Other: No description available. ,
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
Summary: No description available. ,
Transactions: No description available. ,
}
,
Required: False ,
}
enum ,
dueDate:
{
Description: The due date for the invoice. ,
Format: date-time ,
Required: False ,
}
string ,
failedPayments:
{
Description: List of failed payments. ,
Required: False ,
}
[
{
date:
{
Description: The date when the payment was attempted. ,
Format: date-time ,
Required: False ,
}
string ,
failedPaymentReason:
{
Description: The reason that the payment failed. ,
Enum:
{
Other: No description available. ,
BankDeclined: No description available. ,
CardExpired: No description available. ,
IncorrectCardDetails: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
freeAzureCreditApplied:
{
Description: The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when the invoice was generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceType:
{
Description: Invoice type. ,
Enum:
{
Other: No description available. ,
AzureServices: No description available. ,
AzureMarketplace: No description available. ,
AzureSupport: No description available. ,
}
,
Required: False ,
}
enum ,
isMonthlyInvoice:
{
Description: Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
boolean ,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
amount:
{
Description: The paid amount. ,
Required: False ,
}
string ,
date:
{
Description: The date when the payment was made. ,
Format: date-time ,
Required: False ,
}
string ,
paymentMethodId:
{
Description: The ID that uniquely identifies the payment method used for the invoice. ,
Required: False ,
}
string ,
paymentMethodFamily:
{
Description: The family of payment method. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
}
,
]
,
purchaseOrderNumber:
{
Description: An optional purchase order number for the invoice. ,
Required: False ,
}
string ,
rebillDetails:
{
Description: Rebill details for an invoice. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the invoice. ,
Enum:
{
Other: No description available. ,
Due: No description available. ,
OverDue: No description available. ,
Paid: No description available. ,
Void: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionDisplayName:
{
Description: The name of the billing subscription for which the invoice is generated. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
Required: False ,
}
string ,
specialTaxationType:
{
Description: Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic. ,
Enum:
{
SubtotalLevel: No description available. ,
InvoiceLevel: No description available. ,
}
,
Required: False ,
}
enum ,
subTotal:
{
Description: The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
taxAmount:
{
Description: The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
totalAmount:
{
Description: The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
refundDetails:
{
Description: The details of a refund request. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Invoices_Get (removed)
Description :  Gets an invoice by ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/default/invoices/{invoiceName}
{
invoiceName:
{
Description: The ID that uniquely identifies an invoice. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: An invoice. ,
Required: False ,
}
{
amountDue:
{
Description: The amount due as of now. ,
Required: False ,
}
string ,
azurePrepaymentApplied:
{
Description: The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
billedAmount:
{
Description: The total charges for the invoice billing period. ,
Required: False ,
}
string ,
billedDocumentId:
{
Description: The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
creditAmount:
{
Description: The total refund for returns and cancellations during the invoice billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
creditForDocumentId:
{
Description: The Id of the invoice which got voided and this credit note was issued as a result. This field is applicable to the credit notes only. ,
Required: False ,
}
string ,
documents:
{
Description: List of documents available to download and view such as invoice, credit note, or tax receipt. ,
Required: False ,
}
[
{
documentNumbers:
{
Description: The document numbers for the invoice document. ,
Required: False ,
}
[
string ,
]
,
externalUrl:
{
Description: The URL to download the invoice document if the source is external to Microsoft.Billing. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the document. ,
Enum:
{
Other: No description available. ,
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
Summary: No description available. ,
Transactions: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The ID that uniquely identifies an invoice document. This ID may be an identifier for an invoice PDF, a credit note, or a tax receipt. ,
Required: False ,
}
string ,
url:
{
Description: The URL to download the invoice document if the source is internal to Microsoft.Billing. ,
Required: False ,
}
string ,
source:
{
Description: The source of the document. ENF for Brazil and DRS for rest of the world. ,
Enum:
{
Other: No description available. ,
DRS: No description available. ,
ENF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
documentType:
{
Description: The type of the document. ,
Enum:
{
Other: No description available. ,
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
Summary: No description available. ,
Transactions: No description available. ,
}
,
Required: False ,
}
enum ,
dueDate:
{
Description: The due date for the invoice. ,
Format: date-time ,
Required: False ,
}
string ,
failedPayments:
{
Description: List of failed payments. ,
Required: False ,
}
[
{
date:
{
Description: The date when the payment was attempted. ,
Format: date-time ,
Required: False ,
}
string ,
failedPaymentReason:
{
Description: The reason that the payment failed. ,
Enum:
{
Other: No description available. ,
BankDeclined: No description available. ,
CardExpired: No description available. ,
IncorrectCardDetails: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
freeAzureCreditApplied:
{
Description: The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when the invoice was generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceType:
{
Description: Invoice type. ,
Enum:
{
Other: No description available. ,
AzureServices: No description available. ,
AzureMarketplace: No description available. ,
AzureSupport: No description available. ,
}
,
Required: False ,
}
enum ,
isMonthlyInvoice:
{
Description: Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
boolean ,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
amount:
{
Description: The paid amount. ,
Required: False ,
}
string ,
date:
{
Description: The date when the payment was made. ,
Format: date-time ,
Required: False ,
}
string ,
paymentMethodId:
{
Description: The ID that uniquely identifies the payment method used for the invoice. ,
Required: False ,
}
string ,
paymentMethodFamily:
{
Description: The family of payment method. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
}
,
]
,
purchaseOrderNumber:
{
Description: An optional purchase order number for the invoice. ,
Required: False ,
}
string ,
rebillDetails:
{
Description: Rebill details for an invoice. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the invoice. ,
Enum:
{
Other: No description available. ,
Due: No description available. ,
OverDue: No description available. ,
Paid: No description available. ,
Void: No description available. ,
Locked: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionDisplayName:
{
Description: The name of the billing subscription for which the invoice is generated. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
Required: False ,
}
string ,
specialTaxationType:
{
Description: Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic. ,
Enum:
{
SubtotalLevel: No description available. ,
InvoiceLevel: No description available. ,
}
,
Required: False ,
}
enum ,
subTotal:
{
Description: The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
taxAmount:
{
Description: The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
totalAmount:
{
Description: The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
string ,
refundDetails:
{
Description: The details of a refund request. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InvoiceSections_ValidateDeleteEligibility (removed)
Description :  Validates if the invoice section can be deleted. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
eligibilityStatus:
{
Description: Status describing if invoice section is eligible to be deleted. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
eligibilityDetails:
{
Description: A list of delete invoice section eligibility result details. ,
Required: False ,
}
[
{
code:
{
Description: Code for the delete invoice section validation. ,
Enum:
{
Other: No description available. ,
LastInvoiceSection: No description available. ,
ActiveAzurePlans: No description available. ,
ReservedInstances: No description available. ,
ActiveBillingSubscriptions: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Validation message. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InvoiceSections_Delete (removed)
Description :  Deletes an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InvoiceSections_Get (removed)
Description :  Gets an invoice section by its ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: An invoice section. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the status of an invoice section. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
Disabled: No description available. ,
UnderReview: No description available. ,
Warned: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
reasonCode:
{
Description: Reason for the specified invoice section status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InvoiceSections_CreateOrUpdate (removed)
Description :  Creates or updates an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: An invoice section. ,
Required: True ,
}
{
properties:
{
Description: An invoice section. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the status of an invoice section. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
Disabled: No description available. ,
UnderReview: No description available. ,
Warned: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
reasonCode:
{
Description: Reason for the specified invoice section status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: An invoice section. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the status of an invoice section. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
Disabled: No description available. ,
UnderReview: No description available. ,
Warned: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
reasonCode:
{
Description: Reason for the specified invoice section status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: An invoice section. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the status of an invoice section. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
Disabled: No description available. ,
UnderReview: No description available. ,
Warned: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
reasonCode:
{
Description: Reason for the specified invoice section status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
includeDeleted:
{
Description: Can be used to get deleted invoice sections. ,
Required: False ,
}
boolean ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: An invoice section. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the status of an invoice section. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Deleted: No description available. ,
Disabled: No description available. ,
UnderReview: No description available. ,
Warned: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
reasonCode:
{
Description: Reason for the specified invoice section status. ,
Enum:
{
Other: No description available. ,
PastDue: No description available. ,
UnusualActivity: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  List of operations supported by provider.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action". ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PaymentMethods_ListByBillingProfile (removed)
Description :  Lists payment methods attached to a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of payment method links. ,
Required: False ,
}
[
{
properties:
{
Description: Payment method link properties ,
Required: False ,
}
{
accountHolderName:
{
Description: The account holder name for the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the payment method. ,
Required: False ,
}
string ,
expiration:
{
Description: The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
family:
{
Description: The family of payment method. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
lastFourDigits:
{
Description: Last four digits of payment method. ,
Required: False ,
}
string ,
logos:
{
Description: The list of logos for the payment method. ,
Required: False ,
}
[
{
mimeType:
{
Description: MIME type of the logo. ,
Required: False ,
}
string ,
url:
{
Description: Public URL of image of the logo. ,
Required: False ,
}
string ,
}
,
]
,
paymentMethod:
{
Description: Projection of a payment method. Will not be returned in this or future versions. ,
Required: False ,
}
{
id:
{
Description: Id of payment method. ,
Required: False ,
}
string ,
accountHolderName:
{
Description: The account holder name for the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the payment method. ,
Required: False ,
}
string ,
expiration:
{
Description: The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
family:
{
Description: The family of payment method. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
lastFourDigits:
{
Description: Last four digits of payment method. ,
Required: False ,
}
string ,
logos:
{
Description: The list of logos for the payment method. ,
Required: False ,
}
[
{
mimeType:
{
Description: MIME type of the logo. ,
Required: False ,
}
string ,
url:
{
Description: Public URL of image of the logo. ,
Required: False ,
}
string ,
}
,
]
,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
status:
{
Description: Status of the payment method. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
paymentMethodId:
{
Description: Id of payment method. Example: /providers/Microsoft.Billing/paymentMethods/ABCDABCDABC0 ,
Required: False ,
}
string ,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
status:
{
Description: Status of the payment method. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PaymentMethods_GetByBillingProfile (removed)
Description :  Gets a payment method linked with a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Payment method link properties ,
Required: False ,
}
{
accountHolderName:
{
Description: The account holder name for the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the payment method. ,
Required: False ,
}
string ,
expiration:
{
Description: The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
family:
{
Description: The family of payment method. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
lastFourDigits:
{
Description: Last four digits of payment method. ,
Required: False ,
}
string ,
logos:
{
Description: The list of logos for the payment method. ,
Required: False ,
}
[
{
mimeType:
{
Description: MIME type of the logo. ,
Required: False ,
}
string ,
url:
{
Description: Public URL of image of the logo. ,
Required: False ,
}
string ,
}
,
]
,
paymentMethod:
{
Description: Projection of a payment method. Will not be returned in this or future versions. ,
Required: False ,
}
{
id:
{
Description: Id of payment method. ,
Required: False ,
}
string ,
accountHolderName:
{
Description: The account holder name for the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the payment method. ,
Required: False ,
}
string ,
expiration:
{
Description: The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
family:
{
Description: The family of payment method. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
lastFourDigits:
{
Description: Last four digits of payment method. ,
Required: False ,
}
string ,
logos:
{
Description: The list of logos for the payment method. ,
Required: False ,
}
[
{
mimeType:
{
Description: MIME type of the logo. ,
Required: False ,
}
string ,
url:
{
Description: Public URL of image of the logo. ,
Required: False ,
}
string ,
}
,
]
,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
status:
{
Description: Status of the payment method. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
paymentMethodId:
{
Description: Id of payment method. Example: /providers/Microsoft.Billing/paymentMethods/ABCDABCDABC0 ,
Required: False ,
}
string ,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
status:
{
Description: Status of the payment method. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PaymentMethods_ListByBillingAccount (removed)
Description :  Lists the payment methods available for a billing account. Along with the payment methods owned by the caller, these payment methods can be attached to a billing profile to make payments. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of payment methods. ,
Required: False ,
}
[
{
properties:
{
Description: Payment method properties ,
Required: False ,
}
{
id:
{
Description: Id of payment method. ,
Required: False ,
}
string ,
accountHolderName:
{
Description: The account holder name for the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the payment method. ,
Required: False ,
}
string ,
expiration:
{
Description: The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
family:
{
Description: The family of payment method. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
lastFourDigits:
{
Description: Last four digits of payment method. ,
Required: False ,
}
string ,
logos:
{
Description: The list of logos for the payment method. ,
Required: False ,
}
[
{
mimeType:
{
Description: MIME type of the logo. ,
Required: False ,
}
string ,
url:
{
Description: Public URL of image of the logo. ,
Required: False ,
}
string ,
}
,
]
,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
status:
{
Description: Status of the payment method. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PaymentMethods_GetByBillingAccount (removed)
Description :  Gets a payment method available for a billing account. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Payment method properties ,
Required: False ,
}
{
id:
{
Description: Id of payment method. ,
Required: False ,
}
string ,
accountHolderName:
{
Description: The account holder name for the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the payment method. ,
Required: False ,
}
string ,
expiration:
{
Description: The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
family:
{
Description: The family of payment method. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
lastFourDigits:
{
Description: Last four digits of payment method. ,
Required: False ,
}
string ,
logos:
{
Description: The list of logos for the payment method. ,
Required: False ,
}
[
{
mimeType:
{
Description: MIME type of the logo. ,
Required: False ,
}
string ,
url:
{
Description: Public URL of image of the logo. ,
Required: False ,
}
string ,
}
,
]
,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
status:
{
Description: Status of the payment method. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PaymentMethods_ListByUser (removed)
Description :  Lists the payment methods owned by the caller.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of payment methods. ,
Required: False ,
}
[
{
properties:
{
Description: Payment method properties ,
Required: False ,
}
{
id:
{
Description: Id of payment method. ,
Required: False ,
}
string ,
accountHolderName:
{
Description: The account holder name for the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the payment method. ,
Required: False ,
}
string ,
expiration:
{
Description: The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
family:
{
Description: The family of payment method. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
lastFourDigits:
{
Description: Last four digits of payment method. ,
Required: False ,
}
string ,
logos:
{
Description: The list of logos for the payment method. ,
Required: False ,
}
[
{
mimeType:
{
Description: MIME type of the logo. ,
Required: False ,
}
string ,
url:
{
Description: Public URL of image of the logo. ,
Required: False ,
}
string ,
}
,
]
,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
status:
{
Description: Status of the payment method. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PaymentMethods_DeleteByUser (removed)
Description :  Deletes a payment method owned by the caller.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/paymentMethods/{paymentMethodName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
paymentMethodName:
{
Description: The ID that uniquely identifies a payment method. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PaymentMethods_GetByUser (removed)
Description :  Gets a payment method owned by the caller.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/paymentMethods/{paymentMethodName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
paymentMethodName:
{
Description: The ID that uniquely identifies a payment method. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Payment method properties ,
Required: False ,
}
{
id:
{
Description: Id of payment method. ,
Required: False ,
}
string ,
accountHolderName:
{
Description: The account holder name for the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the payment method. ,
Required: False ,
}
string ,
expiration:
{
Description: The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
family:
{
Description: The family of payment method. ,
Enum:
{
Other: No description available. ,
None: No description available. ,
CreditCard: No description available. ,
Credits: No description available. ,
CheckWire: No description available. ,
EWallet: No description available. ,
TaskOrder: No description available. ,
DirectDebit: No description available. ,
}
,
Required: False ,
}
enum ,
lastFourDigits:
{
Description: Last four digits of payment method. ,
Required: False ,
}
string ,
logos:
{
Description: The list of logos for the payment method. ,
Required: False ,
}
[
{
mimeType:
{
Description: MIME type of the logo. ,
Required: False ,
}
string ,
url:
{
Description: Public URL of image of the logo. ,
Required: False ,
}
string ,
}
,
]
,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
status:
{
Description: Status of the payment method. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policies_GetByCustomer (removed)
Description :  Lists the policies for a customer. This operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/policies/{policyName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
policyName:
{
Description: Service-defined resource names such as 'default' which are reserved resource names. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A policy at customer scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: True ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policies_CreateOrUpdateByCustomer (removed)
Description :  Updates the policies for a customer. This operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/policies/default
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: A policy at customer scope. ,
Required: True ,
}
{
properties:
{
Description: A policy at customer scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: True ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A policy at customer scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: True ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
location: string ,
retry-after: integer ,
}
,
$schema:
{
Description: A policy at customer scope. ,
}
{
properties:
{
Description: A policy at customer scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: True ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policies_GetByBillingProfile (removed)
Description :  Lists the policies for a billing profile. This operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: A policy at billing profile scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
enterpriseAgreementPolicies:
{
Description: The policies for Enterprise Agreement enrollments. ,
Required: False ,
}
string ,
invoiceSectionLabelManagement:
{
Description: The policy that controls invoice section label management at invoice section scope. This is allowed by default. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
marketplacePurchases:
{
Description: The policy that controls whether Azure marketplace purchases are allowed. ,
Enum:
{
Other: No description available. ,
AllAllowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
OnlyFreeAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
reservationPurchases:
{
Description: The policy that controls whether Azure reservation purchases are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
savingsPlanPurchases:
{
Description: The policy that controls whether users with Azure savings plan purchase are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policies_CreateOrUpdateByBillingProfile (removed)
Description :  Updates the policies for a billing profile. This operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/policies/default
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: A policy at billing profile scope. ,
Required: True ,
}
{
properties:
{
Description: A policy at billing profile scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
enterpriseAgreementPolicies:
{
Description: The policies for Enterprise Agreement enrollments. ,
Required: False ,
}
string ,
invoiceSectionLabelManagement:
{
Description: The policy that controls invoice section label management at invoice section scope. This is allowed by default. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
marketplacePurchases:
{
Description: The policy that controls whether Azure marketplace purchases are allowed. ,
Enum:
{
Other: No description available. ,
AllAllowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
OnlyFreeAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
reservationPurchases:
{
Description: The policy that controls whether Azure reservation purchases are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
savingsPlanPurchases:
{
Description: The policy that controls whether users with Azure savings plan purchase are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A policy at billing profile scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
enterpriseAgreementPolicies:
{
Description: The policies for Enterprise Agreement enrollments. ,
Required: False ,
}
string ,
invoiceSectionLabelManagement:
{
Description: The policy that controls invoice section label management at invoice section scope. This is allowed by default. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
marketplacePurchases:
{
Description: The policy that controls whether Azure marketplace purchases are allowed. ,
Enum:
{
Other: No description available. ,
AllAllowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
OnlyFreeAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
reservationPurchases:
{
Description: The policy that controls whether Azure reservation purchases are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
savingsPlanPurchases:
{
Description: The policy that controls whether users with Azure savings plan purchase are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
location: string ,
retry-after: integer ,
}
,
$schema:
{
Description: A policy at billing profile scope. ,
}
{
properties:
{
Description: A policy at billing profile scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
enterpriseAgreementPolicies:
{
Description: The policies for Enterprise Agreement enrollments. ,
Required: False ,
}
string ,
invoiceSectionLabelManagement:
{
Description: The policy that controls invoice section label management at invoice section scope. This is allowed by default. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
marketplacePurchases:
{
Description: The policy that controls whether Azure marketplace purchases are allowed. ,
Enum:
{
Other: No description available. ,
AllAllowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
OnlyFreeAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
reservationPurchases:
{
Description: The policy that controls whether Azure reservation purchases are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
savingsPlanPurchases:
{
Description: The policy that controls whether users with Azure savings plan purchase are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policies_GetByCustomerAtBillingAccount (removed)
Description :  Lists the policies for a customer at billing account scope. This operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: A policy at customer scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: True ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policies_CreateOrUpdateByCustomerAtBillingAccount (removed)
Description :  Updates the policies for a customer at billing account scope. This operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/policies/default
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: A policy at customer scope. ,
Required: True ,
}
{
properties:
{
Description: A policy at customer scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: True ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A policy at customer scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: True ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
location: string ,
retry-after: integer ,
}
,
$schema:
{
Description: A policy at customer scope. ,
}
{
properties:
{
Description: A policy at customer scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: True ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policies_GetByBillingAccount (removed)
Description :  Get the policies for a billing account of Enterprise Agreement type.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: A policy at billing account scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
enterpriseAgreementPolicies:
{
Description: The policies for Enterprise Agreement enrollments. ,
Required: False ,
}
string ,
marketplacePurchases:
{
Description: The policy that controls whether Azure marketplace purchases are allowed. ,
Enum:
{
Other: No description available. ,
AllAllowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
OnlyFreeAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
reservationPurchases:
{
Description: The policy that controls whether Azure reservation purchases are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
savingsPlanPurchases:
{
Description: The policy that controls whether users with Azure savings plan purchase are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policies_CreateOrUpdateByBillingAccount (removed)
Description :  Update the policies for a billing account of Enterprise Agreement type.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/policies/default
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: A policy at billing account scope. ,
Required: True ,
}
{
properties:
{
Description: A policy at billing account scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
enterpriseAgreementPolicies:
{
Description: The policies for Enterprise Agreement enrollments. ,
Required: False ,
}
string ,
marketplacePurchases:
{
Description: The policy that controls whether Azure marketplace purchases are allowed. ,
Enum:
{
Other: No description available. ,
AllAllowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
OnlyFreeAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
reservationPurchases:
{
Description: The policy that controls whether Azure reservation purchases are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
savingsPlanPurchases:
{
Description: The policy that controls whether users with Azure savings plan purchase are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A policy at billing account scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
enterpriseAgreementPolicies:
{
Description: The policies for Enterprise Agreement enrollments. ,
Required: False ,
}
string ,
marketplacePurchases:
{
Description: The policy that controls whether Azure marketplace purchases are allowed. ,
Enum:
{
Other: No description available. ,
AllAllowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
OnlyFreeAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
reservationPurchases:
{
Description: The policy that controls whether Azure reservation purchases are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
savingsPlanPurchases:
{
Description: The policy that controls whether users with Azure savings plan purchase are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
location: string ,
retry-after: integer ,
}
,
$schema:
{
Description: A policy at billing account scope. ,
}
{
properties:
{
Description: A policy at billing account scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
enterpriseAgreementPolicies:
{
Description: The policies for Enterprise Agreement enrollments. ,
Required: False ,
}
string ,
marketplacePurchases:
{
Description: The policy that controls whether Azure marketplace purchases are allowed. ,
Enum:
{
Other: No description available. ,
AllAllowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
OnlyFreeAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
reservationPurchases:
{
Description: The policy that controls whether Azure reservation purchases are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
savingsPlanPurchases:
{
Description: The policy that controls whether users with Azure savings plan purchase are allowed. ,
Enum:
{
Other: No description available. ,
Allowed: No description available. ,
Disabled: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Policies_GetBySubscription (removed)
Description :  Lists the policies that are managed by the Billing Admin for the defined subscriptions. This is supported for Microsoft Online Services Program, Microsoft Customer Agreement and Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/policies/default
{
subscriptionId:
{
Description: The ID that uniquely identifies a billing subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A policy at subscription scope. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource during a long-running operation. ,
Enum:
{
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
New: No description available. ,
Pending: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
policies:
{
Description: List of all policies defined at the billing scope. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
value:
{
Description: The value of the policy. ,
Required: False ,
}
string ,
policyType:
{
Description: The type of the policy. ,
Enum:
{
Other: No description available. ,
UserControlled: No description available. ,
SystemControlled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope at which the policy is defined. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/products
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A product. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityId:
{
Description: The availability of the product. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The frequency at which the product will be billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
endDate:
{
Description: The date when the product will be renewed or canceled. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
lastCharge:
{
Description: The last month charges. ,
Required: False ,
}
string ,
lastChargeDate:
{
Description: The date of the last charge. ,
Required: False ,
}
string ,
productType:
{
Description: The description of the type of product. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the type of product. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku ID of the product. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date when the product was purchased. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased for the product. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the product. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
PastDue: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Canceled: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The id of the tenant in which the product is used. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this product. The fields is not available for Microsoft Partner Agreement products. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Products_ListByBillingProfile (removed)
Description :  Lists the products for a billing profile. These don't include products billed based on usage. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/products
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A product. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityId:
{
Description: The availability of the product. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The frequency at which the product will be billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
endDate:
{
Description: The date when the product will be renewed or canceled. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
lastCharge:
{
Description: The last month charges. ,
Required: False ,
}
string ,
lastChargeDate:
{
Description: The date of the last charge. ,
Required: False ,
}
string ,
productType:
{
Description: The description of the type of product. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the type of product. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku ID of the product. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date when the product was purchased. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased for the product. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the product. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
PastDue: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Canceled: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The id of the tenant in which the product is used. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this product. The fields is not available for Microsoft Partner Agreement products. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/products
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A product. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityId:
{
Description: The availability of the product. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The frequency at which the product will be billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
endDate:
{
Description: The date when the product will be renewed or canceled. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
lastCharge:
{
Description: The last month charges. ,
Required: False ,
}
string ,
lastChargeDate:
{
Description: The date of the last charge. ,
Required: False ,
}
string ,
productType:
{
Description: The description of the type of product. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the type of product. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku ID of the product. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date when the product was purchased. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased for the product. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the product. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
PastDue: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Canceled: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The id of the tenant in which the product is used. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this product. The fields is not available for Microsoft Partner Agreement products. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products/{productName}/move
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
productName:
{
Description: The ID that uniquely identifies a product. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of the product to initiate a transfer. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A product. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityId:
{
Description: The availability of the product. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The frequency at which the product will be billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
endDate:
{
Description: The date when the product will be renewed or canceled. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
lastCharge:
{
Description: The last month charges. ,
Required: False ,
}
string ,
lastChargeDate:
{
Description: The date of the last charge. ,
Required: False ,
}
string ,
productType:
{
Description: The description of the type of product. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the type of product. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku ID of the product. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date when the product was purchased. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased for the product. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the product. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
PastDue: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Canceled: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The id of the tenant in which the product is used. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this product. The fields is not available for Microsoft Partner Agreement products. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

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

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products/{productName}/validateMoveEligibility
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
productName:
{
Description: The ID that uniquely identifies a product. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of the product to initiate a transfer. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
isMoveEligible:
{
Description: Specifies whether the subscription is eligible to be transferred. ,
Required: False ,
}
boolean ,
errorDetails:
{
Description: Error details of the transfer eligibility validation. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Products_Get (removed)
Description :  Gets a product by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: A product. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityId:
{
Description: The availability of the product. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The frequency at which the product will be billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
endDate:
{
Description: The date when the product will be renewed or canceled. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
lastCharge:
{
Description: The last month charges. ,
Required: False ,
}
string ,
lastChargeDate:
{
Description: The date of the last charge. ,
Required: False ,
}
string ,
productType:
{
Description: The description of the type of product. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the type of product. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku ID of the product. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date when the product was purchased. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased for the product. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the product. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
PastDue: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Canceled: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The id of the tenant in which the product is used. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this product. The fields is not available for Microsoft Partner Agreement products. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Products_Update (removed)
Description :  Updates the properties of a Product. Currently, auto renew can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products/{productName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
productName:
{
Description: The ID that uniquely identifies a product. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: A product. ,
Required: True ,
}
{
properties:
{
Description: A product. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityId:
{
Description: The availability of the product. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The frequency at which the product will be billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
endDate:
{
Description: The date when the product will be renewed or canceled. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
lastCharge:
{
Description: The last month charges. ,
Required: False ,
}
string ,
lastChargeDate:
{
Description: The date of the last charge. ,
Required: False ,
}
string ,
productType:
{
Description: The description of the type of product. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the type of product. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku ID of the product. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date when the product was purchased. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased for the product. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the product. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
PastDue: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Canceled: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The id of the tenant in which the product is used. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this product. The fields is not available for Microsoft Partner Agreement products. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A product. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityId:
{
Description: The availability of the product. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The frequency at which the product will be billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
endDate:
{
Description: The date when the product will be renewed or canceled. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
lastCharge:
{
Description: The last month charges. ,
Required: False ,
}
string ,
lastChargeDate:
{
Description: The date of the last charge. ,
Required: False ,
}
string ,
productType:
{
Description: The description of the type of product. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the type of product. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku ID of the product. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date when the product was purchased. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased for the product. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the product. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
PastDue: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Canceled: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The id of the tenant in which the product is used. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this product. The fields is not available for Microsoft Partner Agreement products. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A product. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityId:
{
Description: The availability of the product. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The frequency at which the product will be billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
endDate:
{
Description: The date when the product will be renewed or canceled. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
lastCharge:
{
Description: The last month charges. ,
Required: False ,
}
string ,
lastChargeDate:
{
Description: The date of the last charge. ,
Required: False ,
}
string ,
productType:
{
Description: The description of the type of product. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the type of product. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku ID of the product. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date when the product was purchased. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased for the product. ,
Format: int64 ,
Required: False ,
}
integer ,
status:
{
Description: The status of the product. ,
Enum:
{
Other: No description available. ,
Active: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
PastDue: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
AutoRenew: No description available. ,
Canceled: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The id of the tenant in which the product is used. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this product. The fields is not available for Microsoft Partner Agreement products. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Reservations_ListByBillingAccount (removed)
Description :  Lists the reservations in the billing account and the roll up counts of reservations group by provisioning states.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservations
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
skiptoken:
{
Description: The number of reservations to skip from the list before returning results ,
Required: False ,
}
number ,
refreshSummary:
{
Description: To indicate whether to refresh the roll up counts of the reservations group by provisioning states ,
Required: False ,
}
string ,
selectedState:
{
Description: The selected provisioning state ,
Required: False ,
}
string ,
take:
{
Description: The number of reservations to return in API response. ,
Required: False ,
}
number ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
summary:
{
Description: The roll out count summary of the reservations ,
Required: False ,
}
{
cancelledCount:
{
Description: The number of reservation in Cancelled state ,
Required: False ,
}
number ,
expiredCount:
{
Description: The number of reservation in Expired state ,
Required: False ,
}
number ,
expiringCount:
{
Description: The number of reservation in Expiring state ,
Required: False ,
}
number ,
failedCount:
{
Description: The number of reservation in Failed state ,
Required: False ,
}
number ,
pendingCount:
{
Description: The number of reservation in Pending state ,
Required: False ,
}
number ,
succeededCount:
{
Description: The number of reservation in Succeeded state ,
Required: False ,
}
number ,
noBenefitCount:
{
Description: The number of reservation in 'No Benefit' state ,
Required: False ,
}
number ,
warningCount:
{
Description: The number of reservation in Warning state ,
Required: False ,
}
number ,
processingCount:
{
Description: The number of reservation in Processing state ,
Required: False ,
}
number ,
}
,
value:
{
Description: The list of reservations. ,
Required: False ,
}
[
{
location:
{
Description: The location of the reservation. ,
Required: False ,
}
string ,
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the reservation ,
Required: False ,
}
string ,
appliedScopes:
{
Description: The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type of the reservation. ,
Required: False ,
}
string ,
archived:
{
Description: Indicates if the reservation is archived ,
Required: False ,
}
boolean ,
capabilities:
{
Description: Capabilities of the reservation ,
Required: False ,
}
string ,
quantity:
{
Description: The number of the reservation. ,
Required: False ,
}
number ,
provisioningState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
effectiveDateTime:
{
Description: The effective date time of the reservation ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: DateTime of the last time the reservation was updated. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: The expiry date of the reservation ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the reservation ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
{
statusCode:
{
Description: The status of the reservation. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
CapacityError: No description available. ,
CapacityRestricted: No description available. ,
Exchanged: No description available. ,
UnknownError: No description available. ,
RiskCheckFailed: No description available. ,
CreditLineCheckFailed: No description available. ,
Warning: No description available. ,
NoBenefitDueToSubscriptionTransfer: No description available. ,
NoBenefitDueToSubscriptionDeletion: No description available. ,
NoBenefit: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties for extended status information ,
Required: False ,
}
{
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
}
,
}
,
billingPlan:
{
Description: The billing plan options available for this sku. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
purchaseDate:
{
Description: This is the date when the reservation was purchased. ,
Format: date ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: This is the date-time when the reservation was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
splitProperties:
{
Description: Properties of reservation split ,
Required: False ,
}
{
splitDestinations:
{
Description: List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
splitSource:
{
Description: Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
mergeProperties:
{
Description: Properties of reservation merge ,
Required: False ,
}
{
mergeDestination:
{
Description: Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
mergeSources:
{
Description: Resource ids of the source reservation's merged to form this reservation. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
}
,
swapProperties:
{
Description: Properties of reservation swap ,
Required: False ,
}
{
swapSource:
{
Description: Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
swapDestination:
{
Description: Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
renew:
{
Description: The renew state of the reservation ,
Required: False ,
}
boolean ,
renewSource:
{
Description: The renew source of the reservation ,
Required: False ,
}
string ,
renewDestination:
{
Description: Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewProperties:
{
Description: The renew properties for a reservation. ,
Required: False ,
}
{
purchaseProperties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. Must be greater than zero. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pricingCurrencyTotal:
{
Description: Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
}
,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: last 7 day utilization trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
productCode:
{
Description: Represents UPN ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Tags for this reservation ,
Required: False ,
}
object ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Description: The name of the reservation sku. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Reservations_ListByBillingProfile (removed)
Description :  Lists the reservations for a billing profile and the roll up counts of reservations group by provisioning state.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/reservations
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
skiptoken:
{
Description: The number of reservations to skip from the list before returning results ,
Required: False ,
}
number ,
refreshSummary:
{
Description: To indicate whether to refresh the roll up counts of the reservations group by provisioning states ,
Required: False ,
}
string ,
selectedState:
{
Description: The selected provisioning state ,
Required: False ,
}
string ,
take:
{
Description: The number of reservations to return in API response. ,
Required: False ,
}
number ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
summary:
{
Description: The roll out count summary of the reservations ,
Required: False ,
}
{
cancelledCount:
{
Description: The number of reservation in Cancelled state ,
Required: False ,
}
number ,
expiredCount:
{
Description: The number of reservation in Expired state ,
Required: False ,
}
number ,
expiringCount:
{
Description: The number of reservation in Expiring state ,
Required: False ,
}
number ,
failedCount:
{
Description: The number of reservation in Failed state ,
Required: False ,
}
number ,
pendingCount:
{
Description: The number of reservation in Pending state ,
Required: False ,
}
number ,
succeededCount:
{
Description: The number of reservation in Succeeded state ,
Required: False ,
}
number ,
noBenefitCount:
{
Description: The number of reservation in 'No Benefit' state ,
Required: False ,
}
number ,
warningCount:
{
Description: The number of reservation in Warning state ,
Required: False ,
}
number ,
processingCount:
{
Description: The number of reservation in Processing state ,
Required: False ,
}
number ,
}
,
value:
{
Description: The list of reservations. ,
Required: False ,
}
[
{
location:
{
Description: The location of the reservation. ,
Required: False ,
}
string ,
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the reservation ,
Required: False ,
}
string ,
appliedScopes:
{
Description: The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type of the reservation. ,
Required: False ,
}
string ,
archived:
{
Description: Indicates if the reservation is archived ,
Required: False ,
}
boolean ,
capabilities:
{
Description: Capabilities of the reservation ,
Required: False ,
}
string ,
quantity:
{
Description: The number of the reservation. ,
Required: False ,
}
number ,
provisioningState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
effectiveDateTime:
{
Description: The effective date time of the reservation ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: DateTime of the last time the reservation was updated. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: The expiry date of the reservation ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the reservation ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
{
statusCode:
{
Description: The status of the reservation. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
CapacityError: No description available. ,
CapacityRestricted: No description available. ,
Exchanged: No description available. ,
UnknownError: No description available. ,
RiskCheckFailed: No description available. ,
CreditLineCheckFailed: No description available. ,
Warning: No description available. ,
NoBenefitDueToSubscriptionTransfer: No description available. ,
NoBenefitDueToSubscriptionDeletion: No description available. ,
NoBenefit: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties for extended status information ,
Required: False ,
}
{
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
}
,
}
,
billingPlan:
{
Description: The billing plan options available for this sku. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
purchaseDate:
{
Description: This is the date when the reservation was purchased. ,
Format: date ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: This is the date-time when the reservation was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
splitProperties:
{
Description: Properties of reservation split ,
Required: False ,
}
{
splitDestinations:
{
Description: List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
splitSource:
{
Description: Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
mergeProperties:
{
Description: Properties of reservation merge ,
Required: False ,
}
{
mergeDestination:
{
Description: Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
mergeSources:
{
Description: Resource ids of the source reservation's merged to form this reservation. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
}
,
swapProperties:
{
Description: Properties of reservation swap ,
Required: False ,
}
{
swapSource:
{
Description: Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
swapDestination:
{
Description: Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
renew:
{
Description: The renew state of the reservation ,
Required: False ,
}
boolean ,
renewSource:
{
Description: The renew source of the reservation ,
Required: False ,
}
string ,
renewDestination:
{
Description: Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewProperties:
{
Description: The renew properties for a reservation. ,
Required: False ,
}
{
purchaseProperties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. Must be greater than zero. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pricingCurrencyTotal:
{
Description: Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
}
,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: last 7 day utilization trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
productCode:
{
Description: Represents UPN ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Tags for this reservation ,
Required: False ,
}
object ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Description: The name of the reservation sku. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Reservations_GetByReservationOrder (removed)
Description :  Get specific Reservation details in the billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservationOrders/{reservationOrderId}/reservations/{reservationId}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
reservationOrderId:
{
Description: Order Id of the reservation ,
Required: True ,
}
string ,
reservationId:
{
Description: Id of the reservation item ,
Required: True ,
}
string ,
expand:
{
Description: May be used to expand the detail information of some properties. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The location of the reservation. ,
Required: False ,
}
string ,
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the reservation ,
Required: False ,
}
string ,
appliedScopes:
{
Description: The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type of the reservation. ,
Required: False ,
}
string ,
archived:
{
Description: Indicates if the reservation is archived ,
Required: False ,
}
boolean ,
capabilities:
{
Description: Capabilities of the reservation ,
Required: False ,
}
string ,
quantity:
{
Description: The number of the reservation. ,
Required: False ,
}
number ,
provisioningState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
effectiveDateTime:
{
Description: The effective date time of the reservation ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: DateTime of the last time the reservation was updated. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: The expiry date of the reservation ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the reservation ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
{
statusCode:
{
Description: The status of the reservation. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
CapacityError: No description available. ,
CapacityRestricted: No description available. ,
Exchanged: No description available. ,
UnknownError: No description available. ,
RiskCheckFailed: No description available. ,
CreditLineCheckFailed: No description available. ,
Warning: No description available. ,
NoBenefitDueToSubscriptionTransfer: No description available. ,
NoBenefitDueToSubscriptionDeletion: No description available. ,
NoBenefit: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties for extended status information ,
Required: False ,
}
{
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
}
,
}
,
billingPlan:
{
Description: The billing plan options available for this sku. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
purchaseDate:
{
Description: This is the date when the reservation was purchased. ,
Format: date ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: This is the date-time when the reservation was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
splitProperties:
{
Description: Properties of reservation split ,
Required: False ,
}
{
splitDestinations:
{
Description: List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
splitSource:
{
Description: Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
mergeProperties:
{
Description: Properties of reservation merge ,
Required: False ,
}
{
mergeDestination:
{
Description: Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
mergeSources:
{
Description: Resource ids of the source reservation's merged to form this reservation. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
}
,
swapProperties:
{
Description: Properties of reservation swap ,
Required: False ,
}
{
swapSource:
{
Description: Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
swapDestination:
{
Description: Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
renew:
{
Description: The renew state of the reservation ,
Required: False ,
}
boolean ,
renewSource:
{
Description: The renew source of the reservation ,
Required: False ,
}
string ,
renewDestination:
{
Description: Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewProperties:
{
Description: The renew properties for a reservation. ,
Required: False ,
}
{
purchaseProperties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. Must be greater than zero. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pricingCurrencyTotal:
{
Description: Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
}
,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: last 7 day utilization trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
productCode:
{
Description: Represents UPN ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Tags for this reservation ,
Required: False ,
}
object ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Description: The name of the reservation sku. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Reservations_UpdateByBillingAccount (removed)
Description :  Update reservation by billing account.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservationOrders/{reservationOrderId}/reservations/{reservationId}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
reservationOrderId:
{
Description: Order Id of the reservation ,
Required: True ,
}
string ,
reservationId:
{
Description: Id of the reservation item ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
body:
{
Description: Request body for patching a reservation ,
Required: True ,
}
{
properties:
{
Description: Properties for reservation patch ,
Required: False ,
}
{
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the reservation ,
Required: False ,
}
string ,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
renewProperties:
{
Required: False ,
}
{
purchaseProperties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. Must be greater than zero. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Description: The name of the reservation sku. ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Tags for this reservation ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
location:
{
Description: The location of the reservation. ,
Required: False ,
}
string ,
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the reservation ,
Required: False ,
}
string ,
appliedScopes:
{
Description: The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type of the reservation. ,
Required: False ,
}
string ,
archived:
{
Description: Indicates if the reservation is archived ,
Required: False ,
}
boolean ,
capabilities:
{
Description: Capabilities of the reservation ,
Required: False ,
}
string ,
quantity:
{
Description: The number of the reservation. ,
Required: False ,
}
number ,
provisioningState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
effectiveDateTime:
{
Description: The effective date time of the reservation ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: DateTime of the last time the reservation was updated. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: The expiry date of the reservation ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the reservation ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
{
statusCode:
{
Description: The status of the reservation. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
CapacityError: No description available. ,
CapacityRestricted: No description available. ,
Exchanged: No description available. ,
UnknownError: No description available. ,
RiskCheckFailed: No description available. ,
CreditLineCheckFailed: No description available. ,
Warning: No description available. ,
NoBenefitDueToSubscriptionTransfer: No description available. ,
NoBenefitDueToSubscriptionDeletion: No description available. ,
NoBenefit: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties for extended status information ,
Required: False ,
}
{
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
}
,
}
,
billingPlan:
{
Description: The billing plan options available for this sku. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
purchaseDate:
{
Description: This is the date when the reservation was purchased. ,
Format: date ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: This is the date-time when the reservation was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
splitProperties:
{
Description: Properties of reservation split ,
Required: False ,
}
{
splitDestinations:
{
Description: List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
splitSource:
{
Description: Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
mergeProperties:
{
Description: Properties of reservation merge ,
Required: False ,
}
{
mergeDestination:
{
Description: Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
mergeSources:
{
Description: Resource ids of the source reservation's merged to form this reservation. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
}
,
swapProperties:
{
Description: Properties of reservation swap ,
Required: False ,
}
{
swapSource:
{
Description: Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
swapDestination:
{
Description: Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
renew:
{
Description: The renew state of the reservation ,
Required: False ,
}
boolean ,
renewSource:
{
Description: The renew source of the reservation ,
Required: False ,
}
string ,
renewDestination:
{
Description: Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewProperties:
{
Description: The renew properties for a reservation. ,
Required: False ,
}
{
purchaseProperties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. Must be greater than zero. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pricingCurrencyTotal:
{
Description: Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
}
,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: last 7 day utilization trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
productCode:
{
Description: Represents UPN ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Tags for this reservation ,
Required: False ,
}
object ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Description: The name of the reservation sku. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
location:
{
Description: URL for determining when an operation has completed. Only use this value only when Azure-AsyncOperation isn't returned. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Reservations_ListByReservationOrder (removed)
Description :  List Reservations within a single ReservationOrder in the billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservationOrders/{reservationOrderId}/reservations
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
reservationOrderId:
{
Description: Order Id of the reservation ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
location:
{
Description: The location of the reservation. ,
Required: False ,
}
string ,
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the reservation ,
Required: False ,
}
string ,
appliedScopes:
{
Description: The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type of the reservation. ,
Required: False ,
}
string ,
archived:
{
Description: Indicates if the reservation is archived ,
Required: False ,
}
boolean ,
capabilities:
{
Description: Capabilities of the reservation ,
Required: False ,
}
string ,
quantity:
{
Description: The number of the reservation. ,
Required: False ,
}
number ,
provisioningState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
effectiveDateTime:
{
Description: The effective date time of the reservation ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: DateTime of the last time the reservation was updated. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: The expiry date of the reservation ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the reservation ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
{
statusCode:
{
Description: The status of the reservation. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
CapacityError: No description available. ,
CapacityRestricted: No description available. ,
Exchanged: No description available. ,
UnknownError: No description available. ,
RiskCheckFailed: No description available. ,
CreditLineCheckFailed: No description available. ,
Warning: No description available. ,
NoBenefitDueToSubscriptionTransfer: No description available. ,
NoBenefitDueToSubscriptionDeletion: No description available. ,
NoBenefit: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties for extended status information ,
Required: False ,
}
{
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
}
,
}
,
billingPlan:
{
Description: The billing plan options available for this sku. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
purchaseDate:
{
Description: This is the date when the reservation was purchased. ,
Format: date ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: This is the date-time when the reservation was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
splitProperties:
{
Description: Properties of reservation split ,
Required: False ,
}
{
splitDestinations:
{
Description: List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
splitSource:
{
Description: Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
mergeProperties:
{
Description: Properties of reservation merge ,
Required: False ,
}
{
mergeDestination:
{
Description: Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
mergeSources:
{
Description: Resource ids of the source reservation's merged to form this reservation. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
}
,
swapProperties:
{
Description: Properties of reservation swap ,
Required: False ,
}
{
swapSource:
{
Description: Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
swapDestination:
{
Description: Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
renew:
{
Description: The renew state of the reservation ,
Required: False ,
}
boolean ,
renewSource:
{
Description: The renew source of the reservation ,
Required: False ,
}
string ,
renewDestination:
{
Description: Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewProperties:
{
Description: The renew properties for a reservation. ,
Required: False ,
}
{
purchaseProperties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. Must be greater than zero. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pricingCurrencyTotal:
{
Description: Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
}
,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: last 7 day utilization trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
productCode:
{
Description: Represents UPN ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Tags for this reservation ,
Required: False ,
}
object ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Description: The name of the reservation sku. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Url to get the next page of reservations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReservationOrders_GetByBillingAccount (removed)
Description :  Get the details of the ReservationOrder in the billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservationOrders/{reservationOrderId}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
reservationOrderId:
{
Description: Order Id of the reservation ,
Required: True ,
}
string ,
expand:
{
Description: May be used to expand the detail information of some properties. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
properties:
{
Description: The properties associated to this reservation order ,
Required: False ,
}
{
displayName:
{
Description: Friendly name for user to easily identified the reservation order. ,
Required: False ,
}
string ,
enrollmentId:
{
Description: Enrollment id of the reservation order. ,
Required: False ,
}
string ,
customerId:
{
Description: Fully-qualified identifier of the customerId where the benefit is applied. Present only for Enterprise Agreement PartnerLed customers. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing profile Id associated to this reservation order. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: Billing account Id associated to this reservation order. ,
Required: False ,
}
string ,
requestDateTime:
{
Description: This is the DateTime when the reservation order was initially requested for purchase. ,
Format: date-time ,
Required: False ,
}
string ,
createdDateTime:
{
Description: This is the DateTime when the reservation order was created. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: This is the date when the reservation order will expire. ,
Format: date ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation order will expire. ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
originalQuantity:
{
Description: Total original quantity of the skus purchased in the reservation order. ,
Format: int32 ,
Required: False ,
}
integer ,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
planInformation:
{
Description: Information describing the type of billing plan for this reservation order. ,
Required: False ,
}
{
pricingCurrencyTotal:
{
Description: Amount of money to be paid for the Order. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
startDate:
{
Description: Date when the billing plan has started. ,
Format: date ,
Required: False ,
}
string ,
nextPaymentDueDate:
{
Description: For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off. ,
Format: date ,
Required: False ,
}
string ,
transactions:
{
Required: False ,
}
[
{
dueDate:
{
Description: Date when the payment needs to be done. ,
Format: date ,
Required: False ,
}
string ,
paymentDate:
{
Description: Date when the transaction is completed. Is null when it is scheduled. ,
Format: date ,
Required: False ,
}
string ,
pricingCurrencyTotal:
{
Description: Amount in pricing currency. Tax not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Amount charged in Billing currency. Tax not included. Is null for future payments ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingAccount:
{
Description: Shows the Account that is charged for this payment. ,
Required: False ,
}
string ,
status:
{
Description: Describes whether the payment is completed, failed, cancelled or scheduled in the future. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Scheduled: No description available. ,
Cancelled: No description available. ,
Pending: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
extendedStatusInfo:
{
Description: Extended status information for the reservation. ,
Required: False ,
}
{
statusCode:
{
Description: The status of the reservation. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
CapacityError: No description available. ,
CapacityRestricted: No description available. ,
Exchanged: No description available. ,
UnknownError: No description available. ,
RiskCheckFailed: No description available. ,
CreditLineCheckFailed: No description available. ,
Warning: No description available. ,
NoBenefitDueToSubscriptionTransfer: No description available. ,
NoBenefitDueToSubscriptionDeletion: No description available. ,
NoBenefit: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties for extended status information ,
Required: False ,
}
{
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
reservations:
{
Required: False ,
}
[
{
location:
{
Description: The location of the reservation. ,
Required: False ,
}
string ,
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the reservation ,
Required: False ,
}
string ,
appliedScopes:
{
Description: The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type of the reservation. ,
Required: False ,
}
string ,
archived:
{
Description: Indicates if the reservation is archived ,
Required: False ,
}
boolean ,
capabilities:
{
Description: Capabilities of the reservation ,
Required: False ,
}
string ,
quantity:
{
Description: The number of the reservation. ,
Required: False ,
}
number ,
provisioningState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
effectiveDateTime:
{
Description: The effective date time of the reservation ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: DateTime of the last time the reservation was updated. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: The expiry date of the reservation ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the reservation ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
{
statusCode:
{
Description: The status of the reservation. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
CapacityError: No description available. ,
CapacityRestricted: No description available. ,
Exchanged: No description available. ,
UnknownError: No description available. ,
RiskCheckFailed: No description available. ,
CreditLineCheckFailed: No description available. ,
Warning: No description available. ,
NoBenefitDueToSubscriptionTransfer: No description available. ,
NoBenefitDueToSubscriptionDeletion: No description available. ,
NoBenefit: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties for extended status information ,
Required: False ,
}
{
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
}
,
}
,
billingPlan:
{
Description: The billing plan options available for this sku. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
purchaseDate:
{
Description: This is the date when the reservation was purchased. ,
Format: date ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: This is the date-time when the reservation was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
splitProperties:
{
Description: Properties of reservation split ,
Required: False ,
}
{
splitDestinations:
{
Description: List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
splitSource:
{
Description: Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
mergeProperties:
{
Description: Properties of reservation merge ,
Required: False ,
}
{
mergeDestination:
{
Description: Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
mergeSources:
{
Description: Resource ids of the source reservation's merged to form this reservation. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
}
,
swapProperties:
{
Description: Properties of reservation swap ,
Required: False ,
}
{
swapSource:
{
Description: Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
swapDestination:
{
Description: Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
renew:
{
Description: The renew state of the reservation ,
Required: False ,
}
boolean ,
renewSource:
{
Description: The renew source of the reservation ,
Required: False ,
}
string ,
renewDestination:
{
Description: Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewProperties:
{
Description: The renew properties for a reservation. ,
Required: False ,
}
{
purchaseProperties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. Must be greater than zero. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pricingCurrencyTotal:
{
Description: Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
}
,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: last 7 day utilization trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
productCode:
{
Description: Represents UPN ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Tags for this reservation ,
Required: False ,
}
object ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Description: The name of the reservation sku. ,
Required: False ,
}
string ,
}
,
}
,
]
,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: Extended status information for the reservation. ,
Required: False ,
}
{
statusCode:
{
Description: The status of the reservation. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
CapacityError: No description available. ,
CapacityRestricted: No description available. ,
Exchanged: No description available. ,
UnknownError: No description available. ,
RiskCheckFailed: No description available. ,
CreditLineCheckFailed: No description available. ,
Warning: No description available. ,
NoBenefitDueToSubscriptionTransfer: No description available. ,
NoBenefitDueToSubscriptionDeletion: No description available. ,
NoBenefit: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties for extended status information ,
Required: False ,
}
{
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
}
,
}
,
productCode:
{
Description: Represents UPN ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Tags for this reservation ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReservationOrders_ListByBillingAccount (removed)
Description :  List all the `ReservationOrders in the billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservationOrders
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
skiptoken:
{
Description: The number of reservations to skip from the list before returning results ,
Required: False ,
}
number ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
properties:
{
Description: The properties associated to this reservation order ,
Required: False ,
}
{
displayName:
{
Description: Friendly name for user to easily identified the reservation order. ,
Required: False ,
}
string ,
enrollmentId:
{
Description: Enrollment id of the reservation order. ,
Required: False ,
}
string ,
customerId:
{
Description: Fully-qualified identifier of the customerId where the benefit is applied. Present only for Enterprise Agreement PartnerLed customers. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing profile Id associated to this reservation order. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: Billing account Id associated to this reservation order. ,
Required: False ,
}
string ,
requestDateTime:
{
Description: This is the DateTime when the reservation order was initially requested for purchase. ,
Format: date-time ,
Required: False ,
}
string ,
createdDateTime:
{
Description: This is the DateTime when the reservation order was created. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: This is the date when the reservation order will expire. ,
Format: date ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation order will expire. ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
originalQuantity:
{
Description: Total original quantity of the skus purchased in the reservation order. ,
Format: int32 ,
Required: False ,
}
integer ,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
planInformation:
{
Description: Information describing the type of billing plan for this reservation order. ,
Required: False ,
}
{
pricingCurrencyTotal:
{
Description: Amount of money to be paid for the Order. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
startDate:
{
Description: Date when the billing plan has started. ,
Format: date ,
Required: False ,
}
string ,
nextPaymentDueDate:
{
Description: For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off. ,
Format: date ,
Required: False ,
}
string ,
transactions:
{
Required: False ,
}
[
{
dueDate:
{
Description: Date when the payment needs to be done. ,
Format: date ,
Required: False ,
}
string ,
paymentDate:
{
Description: Date when the transaction is completed. Is null when it is scheduled. ,
Format: date ,
Required: False ,
}
string ,
pricingCurrencyTotal:
{
Description: Amount in pricing currency. Tax not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Amount charged in Billing currency. Tax not included. Is null for future payments ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingAccount:
{
Description: Shows the Account that is charged for this payment. ,
Required: False ,
}
string ,
status:
{
Description: Describes whether the payment is completed, failed, cancelled or scheduled in the future. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Scheduled: No description available. ,
Cancelled: No description available. ,
Pending: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
extendedStatusInfo:
{
Description: Extended status information for the reservation. ,
Required: False ,
}
{
statusCode:
{
Description: The status of the reservation. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
CapacityError: No description available. ,
CapacityRestricted: No description available. ,
Exchanged: No description available. ,
UnknownError: No description available. ,
RiskCheckFailed: No description available. ,
CreditLineCheckFailed: No description available. ,
Warning: No description available. ,
NoBenefitDueToSubscriptionTransfer: No description available. ,
NoBenefitDueToSubscriptionDeletion: No description available. ,
NoBenefit: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties for extended status information ,
Required: False ,
}
{
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
reservations:
{
Required: False ,
}
[
{
location:
{
Description: The location of the reservation. ,
Required: False ,
}
string ,
etag:
{
Format: int32 ,
Required: False ,
}
integer ,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The display name of the reservation ,
Required: False ,
}
string ,
appliedScopes:
{
Description: The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type of the reservation. ,
Required: False ,
}
string ,
archived:
{
Description: Indicates if the reservation is archived ,
Required: False ,
}
boolean ,
capabilities:
{
Description: Capabilities of the reservation ,
Required: False ,
}
string ,
quantity:
{
Description: The number of the reservation. ,
Required: False ,
}
number ,
provisioningState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
effectiveDateTime:
{
Description: The effective date time of the reservation ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the reservation benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: DateTime of the last time the reservation was updated. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: The expiry date of the reservation ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: This is the date-time when the reservation will expire. ,
Format: date-time ,
Required: False ,
}
string ,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the reservation ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
{
statusCode:
{
Description: The status of the reservation. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
CapacityError: No description available. ,
CapacityRestricted: No description available. ,
Exchanged: No description available. ,
UnknownError: No description available. ,
RiskCheckFailed: No description available. ,
CreditLineCheckFailed: No description available. ,
Warning: No description available. ,
NoBenefitDueToSubscriptionTransfer: No description available. ,
NoBenefitDueToSubscriptionDeletion: No description available. ,
NoBenefit: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties for extended status information ,
Required: False ,
}
{
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
}
,
}
,
billingPlan:
{
Description: The billing plan options available for this sku. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
purchaseDate:
{
Description: This is the date when the reservation was purchased. ,
Format: date ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: This is the date-time when the reservation was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
splitProperties:
{
Description: Properties of reservation split ,
Required: False ,
}
{
splitDestinations:
{
Description: List of destination resource id that are created due to split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
splitSource:
{
Description: Resource id of the reservation from which this is split. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
mergeProperties:
{
Description: Properties of reservation merge ,
Required: False ,
}
{
mergeDestination:
{
Description: Reservation resource id Created due to the merge. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
mergeSources:
{
Description: Resource ids of the source reservation's merged to form this reservation. Format of the resource id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
[
string ,
]
,
}
,
swapProperties:
{
Description: Properties of reservation swap ,
Required: False ,
}
{
swapSource:
{
Description: Resource id of the source reservation that gets swapped. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
swapDestination:
{
Description: Reservation resource id that the original resource gets swapped to. Format of the resource id is /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} ,
Required: False ,
}
string ,
}
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
renew:
{
Description: The renew state of the reservation ,
Required: False ,
}
boolean ,
renewSource:
{
Description: The renew source of the reservation ,
Required: False ,
}
string ,
renewDestination:
{
Description: Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. ,
Required: False ,
}
string ,
renewProperties:
{
Description: The renew properties for a reservation. ,
Required: False ,
}
{
purchaseProperties:
{
Description: The request for reservation purchase ,
Required: False ,
}
{
sku:
{
Description: The name of sku ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of reservation purchase request ,
Required: False ,
}
{
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing reservation or savings plan ,
Required: False ,
}
string ,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
billingPlan:
{
Description: Represent the billing plans. ,
Enum:
{
Upfront: No description available. ,
Monthly: No description available. ,
}
,
Required: False ,
}
enum ,
quantity:
{
Description: Quantity of the skus that are part of the reservation. Must be greater than zero. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Friendly name of the reservation ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopes:
{
Description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. ,
Required: False ,
}
[
string ,
]
,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the reservation should apply benefit. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new reservation on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
instanceFlexibility:
{
Description: Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
reviewDateTime:
{
Description: This is the date-time when the Azure hybrid benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pricingCurrencyTotal:
{
Description: Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
billingCurrencyTotal:
{
Description: Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
}
,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: last 7 day utilization trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
productCode:
{
Description: Represents UPN ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Tags for this reservation ,
Required: False ,
}
object ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Description: The name of the reservation sku. ,
Required: False ,
}
string ,
}
,
}
,
]
,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Description: Extended status information for the reservation. ,
Required: False ,
}
{
statusCode:
{
Description: The status of the reservation. ,
Enum:
{
None: No description available. ,
Pending: No description available. ,
Processing: No description available. ,
Active: No description available. ,
PurchaseError: No description available. ,
PaymentInstrumentError: No description available. ,
Split: No description available. ,
Merged: No description available. ,
Expired: No description available. ,
Succeeded: No description available. ,
CapacityError: No description available. ,
CapacityRestricted: No description available. ,
Exchanged: No description available. ,
UnknownError: No description available. ,
RiskCheckFailed: No description available. ,
CreditLineCheckFailed: No description available. ,
Warning: No description available. ,
NoBenefitDueToSubscriptionTransfer: No description available. ,
NoBenefitDueToSubscriptionDeletion: No description available. ,
NoBenefit: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
properties:
{
Description: Properties for extended status information ,
Required: False ,
}
{
subscriptionId:
{
Description: Subscription Id ,
Required: False ,
}
string ,
}
,
}
,
productCode:
{
Description: Represents UPN ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Tags for this reservation ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Url to get the next page of reservationOrders. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/transactions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Format: date ,
Required: True ,
}
string ,
periodEndDate:
{
Description: The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Format: date ,
Required: True ,
}
string ,
type:
{
Description: The type of transaction. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A transaction. ,
Required: False ,
}
{
azureCreditApplied:
{
Description: The amount of any Azure credits automatically applied to this transaction. ,
Required: False ,
}
string ,
azurePlan:
{
Description: Details of the Azure plan. ,
Required: False ,
}
string ,
billingCurrency:
{
Description: The ISO 4217 code for the currency in which this transaction is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCommitmentDecremented:
{
Description: The amount of Microsoft Azure Consumption Commitment(MACC) decrement through the transaction. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
creditType:
{
Description: The credit type of the transaction. Applies only to credited transactions. ,
Enum:
{
Other: No description available. ,
AzureFreeCredit: No description available. ,
AzureCreditOffer: No description available. ,
ServiceInterruption: No description available. ,
Refund: No description available. ,
}
,
Required: False ,
}
enum ,
date:
{
Description: The date of transaction. ,
Format: date-time ,
Required: False ,
}
string ,
discount:
{
Description: The percentage discount, if any, applied to this transaction. ,
Required: False ,
}
number ,
effectivePrice:
{
Description: The price of the product after applying any discounts. ,
Required: False ,
}
string ,
exchangeRate:
{
Description: The exchange rate used to convert charged amount to billing currency, if applicable. ,
Required: False ,
}
number ,
invoice:
{
Description: Invoice name on which the transaction was billed or 'Pending' if the transaction is not billed. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The fully qualified ID of the invoice on which the transaction was billed. This field is only applicable for transactions which are billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
isThirdParty:
{
Description: Whether or not the transaction is third party. ,
Required: False ,
}
boolean ,
kind:
{
Description: Type of the transaction, billed or unbilled. ,
Enum:
{
Other: No description available. ,
All: No description available. ,
Reservation: No description available. ,
}
,
Required: False ,
}
enum ,
marketPrice:
{
Description: The retail price of the product. ,
Required: False ,
}
string ,
partNumber:
{
Description: The part number of the product for which the transaction took place. The field is only applicable for Enterprise Agreement invoices. ,
Required: False ,
}
string ,
pricingCurrency:
{
Description: The ISO 4217 code for the currency in which the product is priced. ,
Required: False ,
}
string ,
productDescription:
{
Description: The description of the product for which the transaction took place. ,
Required: False ,
}
string ,
productFamily:
{
Description: The family of the product for which the transaction took place. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product type for which the transaction took place. ,
Required: False ,
}
string ,
productType:
{
Description: The type of the product for which the transaction took place. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased in the transaction. ,
Format: int32 ,
Required: False ,
}
integer ,
reasonCode:
{
Description: There reason code for the transaction. ,
Required: False ,
}
string ,
servicePeriodStartDate:
{
Description: The date of the purchase of the product, or the start date of the month in which usage started. ,
Format: date-time ,
Required: False ,
}
string ,
servicePeriodEndDate:
{
Description: The end date of the product term, or the end date of the month in which usage ended. ,
Format: date-time ,
Required: False ,
}
string ,
subTotal:
{
Description: The pre-tax charged amount for the transaction. ,
Required: False ,
}
string ,
tax:
{
Description: The tax amount applied to the transaction. ,
Required: False ,
}
string ,
transactionAmount:
{
Description: The charge associated with the transaction. ,
Required: False ,
}
string ,
transactionType:
{
Description: The type of transaction. ,
Required: False ,
}
string ,
units:
{
Description: The number of units used for a given product. ,
Required: False ,
}
number ,
unitOfMeasure:
{
Description: The unit of measure used to bill for the product. For example, compute services are billed per hour. ,
Required: False ,
}
string ,
unitType:
{
Description: The description for the unit of measure for a given product. ,
Required: False ,
}
string ,
specialTaxationType:
{
Description: Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic. ,
Enum:
{
SubtotalLevel: No description available. ,
InvoiceLevel: No description available. ,
}
,
Required: False ,
}
enum ,
refundTransactionDetails:
{
Description: The refund details of a transaction. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/transactions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Format: date ,
Required: True ,
}
string ,
periodEndDate:
{
Description: The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Format: date ,
Required: True ,
}
string ,
type:
{
Description: The type of transaction. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A transaction. ,
Required: False ,
}
{
azureCreditApplied:
{
Description: The amount of any Azure credits automatically applied to this transaction. ,
Required: False ,
}
string ,
azurePlan:
{
Description: Details of the Azure plan. ,
Required: False ,
}
string ,
billingCurrency:
{
Description: The ISO 4217 code for the currency in which this transaction is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCommitmentDecremented:
{
Description: The amount of Microsoft Azure Consumption Commitment(MACC) decrement through the transaction. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
creditType:
{
Description: The credit type of the transaction. Applies only to credited transactions. ,
Enum:
{
Other: No description available. ,
AzureFreeCredit: No description available. ,
AzureCreditOffer: No description available. ,
ServiceInterruption: No description available. ,
Refund: No description available. ,
}
,
Required: False ,
}
enum ,
date:
{
Description: The date of transaction. ,
Format: date-time ,
Required: False ,
}
string ,
discount:
{
Description: The percentage discount, if any, applied to this transaction. ,
Required: False ,
}
number ,
effectivePrice:
{
Description: The price of the product after applying any discounts. ,
Required: False ,
}
string ,
exchangeRate:
{
Description: The exchange rate used to convert charged amount to billing currency, if applicable. ,
Required: False ,
}
number ,
invoice:
{
Description: Invoice name on which the transaction was billed or 'Pending' if the transaction is not billed. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The fully qualified ID of the invoice on which the transaction was billed. This field is only applicable for transactions which are billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
isThirdParty:
{
Description: Whether or not the transaction is third party. ,
Required: False ,
}
boolean ,
kind:
{
Description: Type of the transaction, billed or unbilled. ,
Enum:
{
Other: No description available. ,
All: No description available. ,
Reservation: No description available. ,
}
,
Required: False ,
}
enum ,
marketPrice:
{
Description: The retail price of the product. ,
Required: False ,
}
string ,
partNumber:
{
Description: The part number of the product for which the transaction took place. The field is only applicable for Enterprise Agreement invoices. ,
Required: False ,
}
string ,
pricingCurrency:
{
Description: The ISO 4217 code for the currency in which the product is priced. ,
Required: False ,
}
string ,
productDescription:
{
Description: The description of the product for which the transaction took place. ,
Required: False ,
}
string ,
productFamily:
{
Description: The family of the product for which the transaction took place. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product type for which the transaction took place. ,
Required: False ,
}
string ,
productType:
{
Description: The type of the product for which the transaction took place. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased in the transaction. ,
Format: int32 ,
Required: False ,
}
integer ,
reasonCode:
{
Description: There reason code for the transaction. ,
Required: False ,
}
string ,
servicePeriodStartDate:
{
Description: The date of the purchase of the product, or the start date of the month in which usage started. ,
Format: date-time ,
Required: False ,
}
string ,
servicePeriodEndDate:
{
Description: The end date of the product term, or the end date of the month in which usage ended. ,
Format: date-time ,
Required: False ,
}
string ,
subTotal:
{
Description: The pre-tax charged amount for the transaction. ,
Required: False ,
}
string ,
tax:
{
Description: The tax amount applied to the transaction. ,
Required: False ,
}
string ,
transactionAmount:
{
Description: The charge associated with the transaction. ,
Required: False ,
}
string ,
transactionType:
{
Description: The type of transaction. ,
Required: False ,
}
string ,
units:
{
Description: The number of units used for a given product. ,
Required: False ,
}
number ,
unitOfMeasure:
{
Description: The unit of measure used to bill for the product. For example, compute services are billed per hour. ,
Required: False ,
}
string ,
unitType:
{
Description: The description for the unit of measure for a given product. ,
Required: False ,
}
string ,
specialTaxationType:
{
Description: Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic. ,
Enum:
{
SubtotalLevel: No description available. ,
InvoiceLevel: No description available. ,
}
,
Required: False ,
}
enum ,
refundTransactionDetails:
{
Description: The refund details of a transaction. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/transactions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Format: date ,
Required: True ,
}
string ,
periodEndDate:
{
Description: The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Format: date ,
Required: True ,
}
string ,
type:
{
Description: The type of transaction. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A transaction. ,
Required: False ,
}
{
azureCreditApplied:
{
Description: The amount of any Azure credits automatically applied to this transaction. ,
Required: False ,
}
string ,
azurePlan:
{
Description: Details of the Azure plan. ,
Required: False ,
}
string ,
billingCurrency:
{
Description: The ISO 4217 code for the currency in which this transaction is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCommitmentDecremented:
{
Description: The amount of Microsoft Azure Consumption Commitment(MACC) decrement through the transaction. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
creditType:
{
Description: The credit type of the transaction. Applies only to credited transactions. ,
Enum:
{
Other: No description available. ,
AzureFreeCredit: No description available. ,
AzureCreditOffer: No description available. ,
ServiceInterruption: No description available. ,
Refund: No description available. ,
}
,
Required: False ,
}
enum ,
date:
{
Description: The date of transaction. ,
Format: date-time ,
Required: False ,
}
string ,
discount:
{
Description: The percentage discount, if any, applied to this transaction. ,
Required: False ,
}
number ,
effectivePrice:
{
Description: The price of the product after applying any discounts. ,
Required: False ,
}
string ,
exchangeRate:
{
Description: The exchange rate used to convert charged amount to billing currency, if applicable. ,
Required: False ,
}
number ,
invoice:
{
Description: Invoice name on which the transaction was billed or 'Pending' if the transaction is not billed. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The fully qualified ID of the invoice on which the transaction was billed. This field is only applicable for transactions which are billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
isThirdParty:
{
Description: Whether or not the transaction is third party. ,
Required: False ,
}
boolean ,
kind:
{
Description: Type of the transaction, billed or unbilled. ,
Enum:
{
Other: No description available. ,
All: No description available. ,
Reservation: No description available. ,
}
,
Required: False ,
}
enum ,
marketPrice:
{
Description: The retail price of the product. ,
Required: False ,
}
string ,
partNumber:
{
Description: The part number of the product for which the transaction took place. The field is only applicable for Enterprise Agreement invoices. ,
Required: False ,
}
string ,
pricingCurrency:
{
Description: The ISO 4217 code for the currency in which the product is priced. ,
Required: False ,
}
string ,
productDescription:
{
Description: The description of the product for which the transaction took place. ,
Required: False ,
}
string ,
productFamily:
{
Description: The family of the product for which the transaction took place. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product type for which the transaction took place. ,
Required: False ,
}
string ,
productType:
{
Description: The type of the product for which the transaction took place. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased in the transaction. ,
Format: int32 ,
Required: False ,
}
integer ,
reasonCode:
{
Description: There reason code for the transaction. ,
Required: False ,
}
string ,
servicePeriodStartDate:
{
Description: The date of the purchase of the product, or the start date of the month in which usage started. ,
Format: date-time ,
Required: False ,
}
string ,
servicePeriodEndDate:
{
Description: The end date of the product term, or the end date of the month in which usage ended. ,
Format: date-time ,
Required: False ,
}
string ,
subTotal:
{
Description: The pre-tax charged amount for the transaction. ,
Required: False ,
}
string ,
tax:
{
Description: The tax amount applied to the transaction. ,
Required: False ,
}
string ,
transactionAmount:
{
Description: The charge associated with the transaction. ,
Required: False ,
}
string ,
transactionType:
{
Description: The type of transaction. ,
Required: False ,
}
string ,
units:
{
Description: The number of units used for a given product. ,
Required: False ,
}
number ,
unitOfMeasure:
{
Description: The unit of measure used to bill for the product. For example, compute services are billed per hour. ,
Required: False ,
}
string ,
unitType:
{
Description: The description for the unit of measure for a given product. ,
Required: False ,
}
string ,
specialTaxationType:
{
Description: Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic. ,
Enum:
{
SubtotalLevel: No description available. ,
InvoiceLevel: No description available. ,
}
,
Required: False ,
}
enum ,
refundTransactionDetails:
{
Description: The refund details of a transaction. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Transactions_ListByInvoice (removed)
Description :  Lists the transactions for an invoice. Transactions include purchases, refunds and Azure usage charges.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/transactions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
invoiceName:
{
Description: The ID that uniquely identifies an invoice. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter a collection of resources that are addressed by a request URL. ,
Required: False ,
}
string ,
orderBy:
{
Description: The orderby query option allows clients to request resources in a particular order. ,
Required: False ,
}
string ,
top:
{
Description: The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50. ,
Format: int64 ,
Required: False ,
}
integer ,
skip:
{
Description: The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. ,
Format: int64 ,
Required: False ,
}
integer ,
count:
{
Description: The count query option allows clients to request a count of the matching resources included with the resources in the response. ,
Required: False ,
}
boolean ,
search:
{
Description: The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: A transaction. ,
Required: False ,
}
{
azureCreditApplied:
{
Description: The amount of any Azure credits automatically applied to this transaction. ,
Required: False ,
}
string ,
azurePlan:
{
Description: Details of the Azure plan. ,
Required: False ,
}
string ,
billingCurrency:
{
Description: The ISO 4217 code for the currency in which this transaction is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The fully qualified ID that uniquely identifies a billing profile. ,
Required: False ,
}
string ,
consumptionCommitmentDecremented:
{
Description: The amount of Microsoft Azure Consumption Commitment(MACC) decrement through the transaction. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
customerId:
{
Description: The fully qualified ID that uniquely identifies a customer. ,
Required: False ,
}
string ,
creditType:
{
Description: The credit type of the transaction. Applies only to credited transactions. ,
Enum:
{
Other: No description available. ,
AzureFreeCredit: No description available. ,
AzureCreditOffer: No description available. ,
ServiceInterruption: No description available. ,
Refund: No description available. ,
}
,
Required: False ,
}
enum ,
date:
{
Description: The date of transaction. ,
Format: date-time ,
Required: False ,
}
string ,
discount:
{
Description: The percentage discount, if any, applied to this transaction. ,
Required: False ,
}
number ,
effectivePrice:
{
Description: The price of the product after applying any discounts. ,
Required: False ,
}
string ,
exchangeRate:
{
Description: The exchange rate used to convert charged amount to billing currency, if applicable. ,
Required: False ,
}
number ,
invoice:
{
Description: Invoice name on which the transaction was billed or 'Pending' if the transaction is not billed. ,
Required: False ,
}
string ,
invoiceId:
{
Description: The fully qualified ID of the invoice on which the transaction was billed. This field is only applicable for transactions which are billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The fully qualified ID that uniquely identifies an invoice section. ,
Required: False ,
}
string ,
isThirdParty:
{
Description: Whether or not the transaction is third party. ,
Required: False ,
}
boolean ,
kind:
{
Description: Type of the transaction, billed or unbilled. ,
Enum:
{
Other: No description available. ,
All: No description available. ,
Reservation: No description available. ,
}
,
Required: False ,
}
enum ,
marketPrice:
{
Description: The retail price of the product. ,
Required: False ,
}
string ,
partNumber:
{
Description: The part number of the product for which the transaction took place. The field is only applicable for Enterprise Agreement invoices. ,
Required: False ,
}
string ,
pricingCurrency:
{
Description: The ISO 4217 code for the currency in which the product is priced. ,
Required: False ,
}
string ,
productDescription:
{
Description: The description of the product for which the transaction took place. ,
Required: False ,
}
string ,
productFamily:
{
Description: The family of the product for which the transaction took place. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product type for which the transaction took place. ,
Required: False ,
}
string ,
productType:
{
Description: The type of the product for which the transaction took place. ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased in the transaction. ,
Format: int32 ,
Required: False ,
}
integer ,
reasonCode:
{
Description: There reason code for the transaction. ,
Required: False ,
}
string ,
servicePeriodStartDate:
{
Description: The date of the purchase of the product, or the start date of the month in which usage started. ,
Format: date-time ,
Required: False ,
}
string ,
servicePeriodEndDate:
{
Description: The end date of the product term, or the end date of the month in which usage ended. ,
Format: date-time ,
Required: False ,
}
string ,
subTotal:
{
Description: The pre-tax charged amount for the transaction. ,
Required: False ,
}
string ,
tax:
{
Description: The tax amount applied to the transaction. ,
Required: False ,
}
string ,
transactionAmount:
{
Description: The charge associated with the transaction. ,
Required: False ,
}
string ,
transactionType:
{
Description: The type of transaction. ,
Required: False ,
}
string ,
units:
{
Description: The number of units used for a given product. ,
Required: False ,
}
number ,
unitOfMeasure:
{
Description: The unit of measure used to bill for the product. For example, compute services are billed per hour. ,
Required: False ,
}
string ,
unitType:
{
Description: The description for the unit of measure for a given product. ,
Required: False ,
}
string ,
specialTaxationType:
{
Description: Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic. ,
Enum:
{
SubtotalLevel: No description available. ,
InvoiceLevel: No description available. ,
}
,
Required: False ,
}
enum ,
refundTransactionDetails:
{
Description: The refund details of a transaction. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Transactions_TransactionsDownloadByInvoice (removed)
Description :  Gets a URL to download the transactions document for an invoice. The operation is supported for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Transactions_GetTransactionSummaryByInvoice (removed)
Description :  Gets the transaction summary for an invoice. Transactions include purchases, refunds and Azure usage charges.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/transactionSummary
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
invoiceName:
{
Description: The ID that uniquely identifies an invoice. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
filter:
{
Description: The filter query option allows clients to filter the line items that are aggregated to create the line item summary. ,
Required: False ,
}
string ,
search:
{
Description: The search query option allows clients to filter the line items that are aggregated to create the line item summary. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
azureCreditApplied:
{
Description: The total amount of any Azure credits applied. ,
Required: False ,
}
number ,
billingCurrency:
{
Description: The ISO 4217 code for the currency in which the transactions are billed. ,
Required: False ,
}
string ,
consumptionCommitmentDecremented:
{
Description: The total Microsoft Azure Consumption Commitment (MACC) decrement through the invoice. ,
Required: False ,
}
number ,
subTotal:
{
Description: The total pre-tax charged amount. ,
Required: False ,
}
number ,
tax:
{
Description: The total tax amount applied. ,
Required: False ,
}
number ,
total:
{
Description: The total charges. ,
Required: False ,
}
number ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Transfers_Get (removed)
Description :  Gets a transfer request by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Expired: No description available. ,
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
Department: No description available. ,
SavingsPlan: No description available. ,
SAAS: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
productName:
{
Description: The name of the product that is transferred. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

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

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/transfers/{transferName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the initiate transfer operation. ,
Required: True ,
}
{
properties:
{
Description: Request parameters to initiate transfer. ,
Required: False ,
}
{
recipientEmailId:
{
Description: The email ID of the recipient to whom the transfer request is sent. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Expired: No description available. ,
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
Department: No description available. ,
SavingsPlan: No description available. ,
SAAS: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
productName:
{
Description: The name of the product that is transferred. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Expired: No description available. ,
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
Department: No description available. ,
SavingsPlan: No description available. ,
SAAS: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
productName:
{
Description: The name of the product that is transferred. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Transfers_Cancel (removed)
Description :  Cancels a transfer request. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Expired: No description available. ,
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
Department: No description available. ,
SavingsPlan: No description available. ,
SAAS: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
productName:
{
Description: The name of the product that is transferred. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of transfers initiated by caller. ,
Required: False ,
}
[
{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Expired: No description available. ,
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
Department: No description available. ,
SavingsPlan: No description available. ,
SAAS: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
productName:
{
Description: The name of the product that is transferred. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
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 error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PartnerTransfers_Get (removed)
Description :  Gets a transfer request by ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/transfers/{transferName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/transfers/{transferName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the initiate transfer operation. ,
Required: True ,
}
{
properties:
{
Description: Request parameters to initiate partner transfer. ,
Required: False ,
}
{
recipientEmailId:
{
Description: The email ID of the recipient to whom the transfer request is sent. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PartnerTransfers_Cancel (removed)
Description :  Cancels a transfer request. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/transfers/{transferName}/cancel
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of transfers initiated by partner. ,
Required: False ,
}
[
{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Expired: No description available. ,
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorCustomerType:
{
Description: The type of customer who sent the transfer request. ,
Enum:
{
Partner: No description available. ,
EA: No description available. ,
}
,
Required: False ,
}
enum ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
resellerName:
{
Description: Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
Department: No description available. ,
SavingsPlan: No description available. ,
SAAS: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
productName:
{
Description: The name of the product that is transferred. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The SKU of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
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 error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecipientTransfers_Accept (removed)
Description :  Accepts a transfer request.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/transfers/{transferName}/accept
{
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the accept transfer operation. ,
Required: True ,
}
{
properties:
{
Description: Request parameters to accept transfer. ,
Required: False ,
}
{
productDetails:
{
Description: Request parameters to accept transfer. ,
Required: False ,
}
[
{
productType:
{
Description: Type of the product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
Department: No description available. ,
SavingsPlan: No description available. ,
SAAS: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecipientTransfers_Validate (removed)
Description :  Validates if a subscription or a reservation can be transferred. Use this operation to validate your subscriptions or reservation before using the accept transfer operation.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/transfers/{transferName}/validate
{
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the validate transfer operation. ,
Required: True ,
}
{
properties:
{
Description: Request parameters to accept transfer. ,
Required: False ,
}
{
productDetails:
{
Description: Request parameters to accept transfer. ,
Required: False ,
}
[
{
productType:
{
Description: Type of the product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
Department: No description available. ,
SavingsPlan: No description available. ,
SAAS: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecipientTransfers_Decline (removed)
Description :  Declines a transfer request.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/transfers/{transferName}/decline
{
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecipientTransfers_Get (removed)
Description :  Gets a transfer request by ID. The caller must be the recipient of the transfer request.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/transfers/{transferName}
{
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecipientTransfers_List (removed)
Description :  Lists the transfer requests received by the caller.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}