Microsoft.Billing (stable:2021-10-01)

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

BillingSubscriptions_ListByBillingAccount (new)
Description :  Lists the subscriptions for a billing account. The operation is currently supported for billing accounts with agreement type Microsoft Customer Agreement, Microsoft Partner Agreement and Microsoft Online Services Program.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of billing subscriptions. ,
Required: False ,
}
[
{
properties:
{
Description: The billing properties of a subscription. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a subscription. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The billing frequency of the subscription in the ISO8601 format. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The display name of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The name of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
customerName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: The billing properties that can be modified. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
{
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
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. ,
}
,
Required: False ,
}
enum ,
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
invoiceSectionId:
{
Description: The ID of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The display name of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The name of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
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: Amount value. ,
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: Amount value. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency of the subscription in the next billing cycle. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts. ,
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: The type of the product for which the subscription is purchased ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product for which the subscription is purchased ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The purchase date of the subscription in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The number of licenses purchased for the subscription ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: The reseller for which the subscription is created. The field is 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: The term details of the subscription at the next renewal. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency of the subscription. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product. ,
Required: False ,
}
string ,
quantity:
{
Description: The number of licenses ,
Format: int64 ,
Required: False ,
}
integer ,
skuId:
{
Description: The SKU ID of the product ,
Required: False ,
}
string ,
termDuration:
{
Description: The term duration of the subscription. Example P1M and P1Y ,
Required: False ,
}
string ,
}
,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the usage-based subscription. This field is only available for usage-based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for the subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
termDuration:
{
Description: The duration for which you can use the subscription. Example P1Y and P1M ,
Required: False ,
}
string ,
termStartDate:
{
Description: The start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: The end date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingSubscriptions_Get (new)
Description :  Gets a subscription by its ID. The operation is currently supported for billing accounts with agreement type Microsoft Customer Agreement, Microsoft Partner Agreement and Microsoft Online Services Program.
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 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The billing properties of a subscription. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a subscription. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The billing frequency of the subscription in the ISO8601 format. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The display name of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The name of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
customerName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: The billing properties that can be modified. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
{
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
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. ,
}
,
Required: False ,
}
enum ,
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
invoiceSectionId:
{
Description: The ID of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The display name of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The name of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
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: Amount value. ,
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: Amount value. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency of the subscription in the next billing cycle. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts. ,
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: The type of the product for which the subscription is purchased ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product for which the subscription is purchased ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The purchase date of the subscription in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The number of licenses purchased for the subscription ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: The reseller for which the subscription is created. The field is 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: The term details of the subscription at the next renewal. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency of the subscription. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product. ,
Required: False ,
}
string ,
quantity:
{
Description: The number of licenses ,
Format: int64 ,
Required: False ,
}
integer ,
skuId:
{
Description: The SKU ID of the product ,
Required: False ,
}
string ,
termDuration:
{
Description: The term duration of the subscription. Example P1M and P1Y ,
Required: False ,
}
string ,
}
,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the usage-based subscription. This field is only available for usage-based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for the subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
termDuration:
{
Description: The duration for which you can use the subscription. Example P1Y and P1M ,
Required: False ,
}
string ,
termStartDate:
{
Description: The start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: The end date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
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 2021-10-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the update billing subscription operation. ,
Required: True ,
}
{
properties:
{
Description: The billing properties of a subscription. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a subscription. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The billing frequency of the subscription in the ISO8601 format. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The display name of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The name of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
customerName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: The billing properties that can be modified. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
{
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
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. ,
}
,
Required: False ,
}
enum ,
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
invoiceSectionId:
{
Description: The ID of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The display name of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The name of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
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: Amount value. ,
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: Amount value. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency of the subscription in the next billing cycle. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts. ,
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: The type of the product for which the subscription is purchased ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product for which the subscription is purchased ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The purchase date of the subscription in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The number of licenses purchased for the subscription ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: The reseller for which the subscription is created. The field is 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: The term details of the subscription at the next renewal. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency of the subscription. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product. ,
Required: False ,
}
string ,
quantity:
{
Description: The number of licenses ,
Format: int64 ,
Required: False ,
}
integer ,
skuId:
{
Description: The SKU ID of the product ,
Required: False ,
}
string ,
termDuration:
{
Description: The term duration of the subscription. Example P1M and P1Y ,
Required: False ,
}
string ,
}
,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the usage-based subscription. This field is only available for usage-based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for the subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
termDuration:
{
Description: The duration for which you can use the subscription. Example P1Y and P1M ,
Required: False ,
}
string ,
termStartDate:
{
Description: The start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: The end date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The billing properties of a subscription. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a subscription. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The billing frequency of the subscription in the ISO8601 format. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The display name of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The name of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
customerName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: The billing properties that can be modified. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
{
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
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. ,
}
,
Required: False ,
}
enum ,
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
invoiceSectionId:
{
Description: The ID of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The display name of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The name of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
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: Amount value. ,
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: Amount value. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency of the subscription in the next billing cycle. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts. ,
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: The type of the product for which the subscription is purchased ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product for which the subscription is purchased ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The purchase date of the subscription in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The number of licenses purchased for the subscription ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: The reseller for which the subscription is created. The field is 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: The term details of the subscription at the next renewal. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency of the subscription. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product. ,
Required: False ,
}
string ,
quantity:
{
Description: The number of licenses ,
Format: int64 ,
Required: False ,
}
integer ,
skuId:
{
Description: The SKU ID of the product ,
Required: False ,
}
string ,
termDuration:
{
Description: The term duration of the subscription. Example P1M and P1Y ,
Required: False ,
}
string ,
}
,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the usage-based subscription. This field is only available for usage-based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for the subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
termDuration:
{
Description: The duration for which you can use the subscription. Example P1Y and P1M ,
Required: False ,
}
string ,
termStartDate:
{
Description: The start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: The end date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingSubscriptions_Delete (new)
Description :  Cancels a billing subscription.
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 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

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

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingSubscriptions_Move (new)
Description :  Moves a subscription's charges 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}/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 2021-10-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the move subscription operation. ,
Required: True ,
}
{
destinationEnrollmentAccountId:
{
Description: The destination enrollment account id. ,
Required: False ,
}
string ,
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The billing properties of a subscription. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a subscription. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The billing frequency of the subscription in the ISO8601 format. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The display name of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The name of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
customerName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: The billing properties that can be modified. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
{
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
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. ,
}
,
Required: False ,
}
enum ,
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
invoiceSectionId:
{
Description: The ID of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The display name of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The name of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
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: Amount value. ,
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: Amount value. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency of the subscription in the next billing cycle. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts. ,
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: The type of the product for which the subscription is purchased ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product for which the subscription is purchased ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The purchase date of the subscription in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The number of licenses purchased for the subscription ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: The reseller for which the subscription is created. The field is 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: The term details of the subscription at the next renewal. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency of the subscription. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product. ,
Required: False ,
}
string ,
quantity:
{
Description: The number of licenses ,
Format: int64 ,
Required: False ,
}
integer ,
skuId:
{
Description: The SKU ID of the product ,
Required: False ,
}
string ,
termDuration:
{
Description: The term duration of the subscription. Example P1M and P1Y ,
Required: False ,
}
string ,
}
,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the usage-based subscription. This field is only available for usage-based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for the subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
termDuration:
{
Description: The duration for which you can use the subscription. Example P1Y and P1M ,
Required: False ,
}
string ,
termStartDate:
{
Description: The start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: The end date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

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

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{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 2021-10-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the validate move eligibility operation. ,
Required: True ,
}
{
destinationEnrollmentAccountId:
{
Description: The destination enrollment account id. ,
Required: False ,
}
string ,
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
isMoveEligible:
{
Description: Specifies whether the subscription is eligible to move. ,
Required: False ,
}
boolean ,
errorDetails:
{
Description: Validation error details. ,
Required: False ,
}
{
code:
{
Description: Error code for the billing subscription move validation. ,
Enum:
{
AccountIsLocked: No description available. ,
AssetNotActive: No description available. ,
AssetHasCap: No description available. ,
BillingAccountInactive: No description available. ,
BillingProfilePastDue: No description available. ,
CrossBillingAccountNotAllowed: No description available. ,
DestinationBillingProfileNotFound: No description available. ,
DestinationBillingProfileInactive: No description available. ,
DestinationBillingProfilePastDue: No description available. ,
DestinationInvoiceSectionNotFound: No description available. ,
DestinationInvoiceSectionInactive: No description available. ,
InvalidDestination: No description available. ,
InvalidSource: No description available. ,
InvoiceSectionIsRestricted: No description available. ,
InsufficientPermissionOnDestination: No description available. ,
InsufficientPermissionOnSource: No description available. ,
MarketplaceNotEnabledOnDestination: No description available. ,
ProductNotFound: No description available. ,
ProductInactive: No description available. ,
ProductTypeNotSupported: No description available. ,
SourceBillingProfilePastDue: No description available. ,
SourceInvoiceSectionInactive: No description available. ,
SubscriptionNotActive: No description available. ,
SubscriptionTypeNotSupported: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: Detailed error message explaining the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
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 2021-10-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 billing properties of a subscription. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a subscription. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The billing frequency of the subscription in the ISO8601 format. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The display name of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The name of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
customerName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: The billing properties that can be modified. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
{
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
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. ,
}
,
Required: False ,
}
enum ,
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
invoiceSectionId:
{
Description: The ID of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The display name of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The name of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
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: Amount value. ,
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: Amount value. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency of the subscription in the next billing cycle. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts. ,
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: The type of the product for which the subscription is purchased ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product for which the subscription is purchased ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The purchase date of the subscription in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The number of licenses purchased for the subscription ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: The reseller for which the subscription is created. The field is 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: The term details of the subscription at the next renewal. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency of the subscription. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product. ,
Required: False ,
}
string ,
quantity:
{
Description: The number of licenses ,
Format: int64 ,
Required: False ,
}
integer ,
skuId:
{
Description: The SKU ID of the product ,
Required: False ,
}
string ,
termDuration:
{
Description: The term duration of the subscription. Example P1M and P1Y ,
Required: False ,
}
string ,
}
,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the usage-based subscription. This field is only available for usage-based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for the subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
termDuration:
{
Description: The duration for which you can use the subscription. Example P1Y and P1M ,
Required: False ,
}
string ,
termStartDate:
{
Description: The start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: The end date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingSubscriptions_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 2021-10-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to split the billing subscription. ,
Required: True ,
}
{
billingFrequency:
{
Description: The billing frequency of the target subscription in the ISO8601 format. Example: P1M, P3M, P1Y ,
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 ,
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 ,
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 ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The billing properties of a subscription. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a subscription. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The billing frequency of the subscription in the ISO8601 format. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The display name of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The name of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
customerName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: The billing properties that can be modified. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
{
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
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. ,
}
,
Required: False ,
}
enum ,
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
invoiceSectionId:
{
Description: The ID of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The display name of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The name of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
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: Amount value. ,
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: Amount value. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency of the subscription in the next billing cycle. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts. ,
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: The type of the product for which the subscription is purchased ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product for which the subscription is purchased ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The purchase date of the subscription in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The number of licenses purchased for the subscription ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: The reseller for which the subscription is created. The field is 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: The term details of the subscription at the next renewal. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency of the subscription. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product. ,
Required: False ,
}
string ,
quantity:
{
Description: The number of licenses ,
Format: int64 ,
Required: False ,
}
integer ,
skuId:
{
Description: The SKU ID of the product ,
Required: False ,
}
string ,
termDuration:
{
Description: The term duration of the subscription. Example P1M and P1Y ,
Required: False ,
}
string ,
}
,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the usage-based subscription. This field is only available for usage-based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for the subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
termDuration:
{
Description: The duration for which you can use the subscription. Example P1Y and P1M ,
Required: False ,
}
string ,
termStartDate:
{
Description: The start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: The end date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
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 ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing subscription aliases. ,
Required: False ,
}
[
{
properties:
{
Description: Billing subscription alias properties. ,
Required: False ,
}
{
billingSubscriptionId:
{
Description: The ID of the billing subscription with the subscription alias. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
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 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Billing subscription alias properties. ,
Required: False ,
}
{
billingSubscriptionId:
{
Description: The ID of the billing subscription with the subscription alias. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
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 2021-10-01. ,
Required: True ,
}
string ,
parameters:
{
Description: New or updated billing subscription alias. ,
Required: True ,
}
{
properties:
{
Description: Billing subscription alias properties. ,
Required: False ,
}
{
billingSubscriptionId:
{
Description: The ID of the billing subscription with the subscription alias. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Billing subscription alias properties. ,
Required: False ,
}
{
billingSubscriptionId:
{
Description: The ID of the billing subscription with the subscription alias. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
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 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of payment methods. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a payment method. ,
Required: False ,
}
{
family:
{
Description: The family of payment method. ,
Enum:
{
CreditCard: No description available. ,
CheckWire: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type 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 ,
expiration:
{
Description: The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
lastFourDigits:
{
Description: Last four digits of payment method. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the 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 ,
}
,
]
,
status:
{
Description: Status of the payment method. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
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 2021-10-01. ,
Required: True ,
}
string ,
paymentMethodName:
{
Description: The ID that uniquely identifies a payment method. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a payment method. ,
Required: False ,
}
{
family:
{
Description: The family of payment method. ,
Enum:
{
CreditCard: No description available. ,
CheckWire: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type 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 ,
expiration:
{
Description: The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
lastFourDigits:
{
Description: Last four digits of payment method. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the 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 ,
}
,
]
,
status:
{
Description: Status of the payment method. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
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 2021-10-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 details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
PaymentMethods_ListByBillingAccount (new)
Description :  Lists the payment methods 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 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of payment methods. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a payment method. ,
Required: False ,
}
{
family:
{
Description: The family of payment method. ,
Enum:
{
CreditCard: No description available. ,
CheckWire: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type 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 ,
expiration:
{
Description: The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
lastFourDigits:
{
Description: Last four digits of payment method. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the 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 ,
}
,
]
,
status:
{
Description: Status of the payment method. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
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 2021-10-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: The properties of a payment method. ,
Required: False ,
}
{
family:
{
Description: The family of payment method. ,
Enum:
{
CreditCard: No description available. ,
CheckWire: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type 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 ,
expiration:
{
Description: The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
lastFourDigits:
{
Description: Last four digits of payment method. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the 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 ,
}
,
]
,
status:
{
Description: Status of the payment method. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
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 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of payment method links. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a payment method link. ,
Required: False ,
}
{
paymentMethod:
{
Description: Projection of a payment method ,
Required: False ,
}
{
id:
{
Description: Id of payment method. ,
Required: False ,
}
string ,
family:
{
Description: The family of payment method. ,
Enum:
{
CreditCard: No description available. ,
CheckWire: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type 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 ,
expiration:
{
Description: The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
lastFourDigits:
{
Description: Last four digits of payment method. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the 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 ,
}
,
]
,
status:
{
Description: Status of the payment method. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
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 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a payment method link. ,
Required: False ,
}
{
paymentMethod:
{
Description: Projection of a payment method ,
Required: False ,
}
{
id:
{
Description: Id of payment method. ,
Required: False ,
}
string ,
family:
{
Description: The family of payment method. ,
Enum:
{
CreditCard: No description available. ,
CheckWire: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type 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 ,
expiration:
{
Description: The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
lastFourDigits:
{
Description: Last four digits of payment method. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the 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 ,
}
,
]
,
status:
{
Description: Status of the payment method. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/paymentMethodLinks/{paymentMethodName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2021-10-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 ,
paymentMethodName:
{
Description: The ID that uniquely identifies a payment method. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (202)

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

⚐ Response (409)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
details:
{
Description: The list of detach payment method eligibility errors. ,
Required: False ,
}
[
{
code:
{
Description: Error code for the detach payment method eligibility validation. ,
Enum:
{
AzureSubscriptions: No description available. ,
RecurringCharges: No description available. ,
ReservedInstances: No description available. ,
OutstandingCharges: No description available. ,
PendingCharges: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Error message for the detach payment method eligibility validation. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of billing subscriptions. ,
Required: False ,
}
[
{
properties:
{
Description: The billing properties of a subscription. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a subscription. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The billing frequency of the subscription in the ISO8601 format. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The display name of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The name of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
customerName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: The billing properties that can be modified. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
{
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
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. ,
}
,
Required: False ,
}
enum ,
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
invoiceSectionId:
{
Description: The ID of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The display name of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The name of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
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: Amount value. ,
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: Amount value. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency of the subscription in the next billing cycle. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts. ,
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: The type of the product for which the subscription is purchased ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product for which the subscription is purchased ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The purchase date of the subscription in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The number of licenses purchased for the subscription ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: The reseller for which the subscription is created. The field is 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: The term details of the subscription at the next renewal. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency of the subscription. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product. ,
Required: False ,
}
string ,
quantity:
{
Description: The number of licenses ,
Format: int64 ,
Required: False ,
}
integer ,
skuId:
{
Description: The SKU ID of the product ,
Required: False ,
}
string ,
termDuration:
{
Description: The term duration of the subscription. Example P1M and P1Y ,
Required: False ,
}
string ,
}
,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the usage-based subscription. This field is only available for usage-based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for the subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
termDuration:
{
Description: The duration for which you can use the subscription. Example P1Y and P1M ,
Required: False ,
}
string ,
termStartDate:
{
Description: The start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: The end date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingSubscriptions_Get (removed)
Description :  Gets a subscription by its ID. The operation is currently supported for billing accounts with agreement type Microsoft Customer Agreement, Microsoft Partner Agreement and Microsoft Online Services Program.
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 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The billing properties of a subscription. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a subscription. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The billing frequency of the subscription in the ISO8601 format. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The display name of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The name of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
customerName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: The billing properties that can be modified. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
{
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
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. ,
}
,
Required: False ,
}
enum ,
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
invoiceSectionId:
{
Description: The ID of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The display name of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The name of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
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: Amount value. ,
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: Amount value. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency of the subscription in the next billing cycle. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts. ,
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: The type of the product for which the subscription is purchased ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product for which the subscription is purchased ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The purchase date of the subscription in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The number of licenses purchased for the subscription ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: The reseller for which the subscription is created. The field is 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: The term details of the subscription at the next renewal. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency of the subscription. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product. ,
Required: False ,
}
string ,
quantity:
{
Description: The number of licenses ,
Format: int64 ,
Required: False ,
}
integer ,
skuId:
{
Description: The SKU ID of the product ,
Required: False ,
}
string ,
termDuration:
{
Description: The term duration of the subscription. Example P1M and P1Y ,
Required: False ,
}
string ,
}
,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the usage-based subscription. This field is only available for usage-based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for the subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
termDuration:
{
Description: The duration for which you can use the subscription. Example P1Y and P1M ,
Required: False ,
}
string ,
termStartDate:
{
Description: The start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: The end date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
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 2021-10-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the update billing subscription operation. ,
Required: True ,
}
{
properties:
{
Description: The billing properties of a subscription. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a subscription. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The billing frequency of the subscription in the ISO8601 format. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The display name of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The name of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
customerName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: The billing properties that can be modified. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
{
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
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. ,
}
,
Required: False ,
}
enum ,
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
invoiceSectionId:
{
Description: The ID of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The display name of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The name of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
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: Amount value. ,
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: Amount value. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency of the subscription in the next billing cycle. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts. ,
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: The type of the product for which the subscription is purchased ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product for which the subscription is purchased ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The purchase date of the subscription in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The number of licenses purchased for the subscription ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: The reseller for which the subscription is created. The field is 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: The term details of the subscription at the next renewal. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency of the subscription. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product. ,
Required: False ,
}
string ,
quantity:
{
Description: The number of licenses ,
Format: int64 ,
Required: False ,
}
integer ,
skuId:
{
Description: The SKU ID of the product ,
Required: False ,
}
string ,
termDuration:
{
Description: The term duration of the subscription. Example P1M and P1Y ,
Required: False ,
}
string ,
}
,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the usage-based subscription. This field is only available for usage-based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for the subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
termDuration:
{
Description: The duration for which you can use the subscription. Example P1Y and P1M ,
Required: False ,
}
string ,
termStartDate:
{
Description: The start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: The end date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The billing properties of a subscription. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a subscription. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The billing frequency of the subscription in the ISO8601 format. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The display name of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The name of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
customerName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: The billing properties that can be modified. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
{
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
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. ,
}
,
Required: False ,
}
enum ,
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
invoiceSectionId:
{
Description: The ID of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The display name of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The name of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
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: Amount value. ,
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: Amount value. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency of the subscription in the next billing cycle. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts. ,
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: The type of the product for which the subscription is purchased ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product for which the subscription is purchased ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The purchase date of the subscription in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The number of licenses purchased for the subscription ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: The reseller for which the subscription is created. The field is 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: The term details of the subscription at the next renewal. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency of the subscription. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product. ,
Required: False ,
}
string ,
quantity:
{
Description: The number of licenses ,
Format: int64 ,
Required: False ,
}
integer ,
skuId:
{
Description: The SKU ID of the product ,
Required: False ,
}
string ,
termDuration:
{
Description: The term duration of the subscription. Example P1M and P1Y ,
Required: False ,
}
string ,
}
,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the usage-based subscription. This field is only available for usage-based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for the subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
termDuration:
{
Description: The duration for which you can use the subscription. Example P1Y and P1M ,
Required: False ,
}
string ,
termStartDate:
{
Description: The start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: The end date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingSubscriptions_Delete (removed)
Description :  Cancels a billing subscription.
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 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

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

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingSubscriptions_Move (removed)
Description :  Moves a subscription's charges 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}/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 2021-10-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the move subscription operation. ,
Required: True ,
}
{
destinationEnrollmentAccountId:
{
Description: The destination enrollment account id. ,
Required: False ,
}
string ,
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The billing properties of a subscription. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a subscription. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The billing frequency of the subscription in the ISO8601 format. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The display name of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The name of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
customerName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: The billing properties that can be modified. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
{
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
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. ,
}
,
Required: False ,
}
enum ,
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
invoiceSectionId:
{
Description: The ID of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The display name of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The name of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
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: Amount value. ,
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: Amount value. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency of the subscription in the next billing cycle. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts. ,
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: The type of the product for which the subscription is purchased ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product for which the subscription is purchased ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The purchase date of the subscription in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The number of licenses purchased for the subscription ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: The reseller for which the subscription is created. The field is 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: The term details of the subscription at the next renewal. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency of the subscription. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product. ,
Required: False ,
}
string ,
quantity:
{
Description: The number of licenses ,
Format: int64 ,
Required: False ,
}
integer ,
skuId:
{
Description: The SKU ID of the product ,
Required: False ,
}
string ,
termDuration:
{
Description: The term duration of the subscription. Example P1M and P1Y ,
Required: False ,
}
string ,
}
,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the usage-based subscription. This field is only available for usage-based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for the subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
termDuration:
{
Description: The duration for which you can use the subscription. Example P1Y and P1M ,
Required: False ,
}
string ,
termStartDate:
{
Description: The start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: The end date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

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

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{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 2021-10-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the validate move eligibility operation. ,
Required: True ,
}
{
destinationEnrollmentAccountId:
{
Description: The destination enrollment account id. ,
Required: False ,
}
string ,
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
isMoveEligible:
{
Description: Specifies whether the subscription is eligible to move. ,
Required: False ,
}
boolean ,
errorDetails:
{
Description: Validation error details. ,
Required: False ,
}
{
code:
{
Description: Error code for the billing subscription move validation. ,
Enum:
{
AccountIsLocked: No description available. ,
AssetNotActive: No description available. ,
AssetHasCap: No description available. ,
BillingAccountInactive: No description available. ,
BillingProfilePastDue: No description available. ,
CrossBillingAccountNotAllowed: No description available. ,
DestinationBillingProfileNotFound: No description available. ,
DestinationBillingProfileInactive: No description available. ,
DestinationBillingProfilePastDue: No description available. ,
DestinationInvoiceSectionNotFound: No description available. ,
DestinationInvoiceSectionInactive: No description available. ,
InvalidDestination: No description available. ,
InvalidSource: No description available. ,
InvoiceSectionIsRestricted: No description available. ,
InsufficientPermissionOnDestination: No description available. ,
InsufficientPermissionOnSource: No description available. ,
MarketplaceNotEnabledOnDestination: No description available. ,
ProductNotFound: No description available. ,
ProductInactive: No description available. ,
ProductTypeNotSupported: No description available. ,
SourceBillingProfilePastDue: No description available. ,
SourceInvoiceSectionInactive: No description available. ,
SubscriptionNotActive: No description available. ,
SubscriptionTypeNotSupported: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: Detailed error message explaining the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
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 2021-10-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 billing properties of a subscription. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a subscription. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The billing frequency of the subscription in the ISO8601 format. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The display name of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The name of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
customerName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: The billing properties that can be modified. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
{
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
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. ,
}
,
Required: False ,
}
enum ,
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
invoiceSectionId:
{
Description: The ID of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The display name of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The name of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
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: Amount value. ,
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: Amount value. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency of the subscription in the next billing cycle. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts. ,
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: The type of the product for which the subscription is purchased ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product for which the subscription is purchased ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The purchase date of the subscription in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The number of licenses purchased for the subscription ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: The reseller for which the subscription is created. The field is 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: The term details of the subscription at the next renewal. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency of the subscription. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product. ,
Required: False ,
}
string ,
quantity:
{
Description: The number of licenses ,
Format: int64 ,
Required: False ,
}
integer ,
skuId:
{
Description: The SKU ID of the product ,
Required: False ,
}
string ,
termDuration:
{
Description: The term duration of the subscription. Example P1M and P1Y ,
Required: False ,
}
string ,
}
,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the usage-based subscription. This field is only available for usage-based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for the subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
termDuration:
{
Description: The duration for which you can use the subscription. Example P1Y and P1M ,
Required: False ,
}
string ,
termStartDate:
{
Description: The start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: The end date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingSubscriptions_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 2021-10-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to split the billing subscription. ,
Required: True ,
}
{
billingFrequency:
{
Description: The billing frequency of the target subscription in the ISO8601 format. Example: P1M, P3M, P1Y ,
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 ,
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 ,
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 ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The billing properties of a subscription. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a subscription. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
beneficiaryTenantId:
{
Description: The provisioning tenant of the subscription. ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The billing frequency of the subscription in the ISO8601 format. Example: P1M, P3M, P1Y ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
billingPolicies:
{
Description: Dictionary of billing policies associated with the subscription. ,
Required: False ,
}
object ,
billingProfileDisplayName:
{
Description: The display name of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The name of the billing profile to which the subscription is billed. This field is only applicable for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
consumptionCostCenter:
{
Description: The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement Type billing accounts. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
customerName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
displayName:
{
Description: The name of the subscription. ,
Required: False ,
}
string ,
enrollmentAccountId:
{
Description: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountDisplayName:
{
Description: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
string ,
enrollmentAccountSubscriptionDetails:
{
Description: The billing properties that can be modified. This field is available only for the Enterprise Agreement billing accounts. ,
Required: False ,
}
{
subscriptionEnrollmentAccountStatus:
{
Description: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement billing accounts. ,
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. ,
}
,
Required: False ,
}
enum ,
enrollmentAccountStartDate:
{
Description: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement billing accounts. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
invoiceSectionId:
{
Description: The ID of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The display name of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: The name of the invoice section to which the subscription is billed. The field is applicable only for Microsoft Partner Agreement billing accounts. ,
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: Amount value. ,
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: Amount value. ,
Required: False ,
}
number ,
}
,
nextBillingCycleDetails:
{
Description: Next billing cycle details of the subscription. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency of the subscription in the next billing cycle. ,
Required: False ,
}
string ,
}
,
offerId:
{
Description: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts. ,
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: The type of the product for which the subscription is purchased ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product for which the subscription is purchased ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The purchase date of the subscription in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The number of licenses purchased for the subscription ,
Format: int64 ,
Required: False ,
}
integer ,
reseller:
{
Description: The reseller for which the subscription is created. The field is 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: The term details of the subscription at the next renewal. ,
Required: False ,
}
{
billingFrequency:
{
Description: The billing frequency of the subscription. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product. ,
Required: False ,
}
string ,
quantity:
{
Description: The number of licenses ,
Format: int64 ,
Required: False ,
}
integer ,
skuId:
{
Description: The SKU ID of the product ,
Required: False ,
}
string ,
termDuration:
{
Description: The term duration of the subscription. Example P1M and P1Y ,
Required: False ,
}
string ,
}
,
skuDescription:
{
Description: The SKU description of the product for which the subscription is purchased. This field is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU ID of the product for which the subscription is purchased. This field is only available for Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
status:
{
Description: The status of the subscription. This field is not available for Enterprise Agreement billing accounts. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
subscriptionId:
{
Description: The ID of the usage-based subscription. This field is only available for usage-based subscriptions of Microsoft Customer Agreement billing accounts. ,
Required: False ,
}
string ,
suspensionReasons:
{
Description: The suspension reason for the subscription. This field is not available for Enterprise Agreement billing accounts. ,
Required: False ,
}
[
string ,
]
,
termDuration:
{
Description: The duration for which you can use the subscription. Example P1Y and P1M ,
Required: False ,
}
string ,
termStartDate:
{
Description: The start date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
termEndDate:
{
Description: The end date of the term in UTC time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
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 ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing subscription aliases. ,
Required: False ,
}
[
{
properties:
{
Description: Billing subscription alias properties. ,
Required: False ,
}
{
billingSubscriptionId:
{
Description: The ID of the billing subscription with the subscription alias. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
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 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Billing subscription alias properties. ,
Required: False ,
}
{
billingSubscriptionId:
{
Description: The ID of the billing subscription with the subscription alias. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
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 2021-10-01. ,
Required: True ,
}
string ,
parameters:
{
Description: New or updated billing subscription alias. ,
Required: True ,
}
{
properties:
{
Description: Billing subscription alias properties. ,
Required: False ,
}
{
billingSubscriptionId:
{
Description: The ID of the billing subscription with the subscription alias. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Billing subscription alias properties. ,
Required: False ,
}
{
billingSubscriptionId:
{
Description: The ID of the billing subscription with the subscription alias. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
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 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of payment methods. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a payment method. ,
Required: False ,
}
{
family:
{
Description: The family of payment method. ,
Enum:
{
CreditCard: No description available. ,
CheckWire: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type 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 ,
expiration:
{
Description: The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
lastFourDigits:
{
Description: Last four digits of payment method. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the 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 ,
}
,
]
,
status:
{
Description: Status of the payment method. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
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 2021-10-01. ,
Required: True ,
}
string ,
paymentMethodName:
{
Description: The ID that uniquely identifies a payment method. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a payment method. ,
Required: False ,
}
{
family:
{
Description: The family of payment method. ,
Enum:
{
CreditCard: No description available. ,
CheckWire: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type 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 ,
expiration:
{
Description: The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
lastFourDigits:
{
Description: Last four digits of payment method. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the 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 ,
}
,
]
,
status:
{
Description: Status of the payment method. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
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 2021-10-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 details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
PaymentMethods_ListByBillingAccount (removed)
Description :  Lists the payment methods 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 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of payment methods. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a payment method. ,
Required: False ,
}
{
family:
{
Description: The family of payment method. ,
Enum:
{
CreditCard: No description available. ,
CheckWire: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type 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 ,
expiration:
{
Description: The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
lastFourDigits:
{
Description: Last four digits of payment method. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the 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 ,
}
,
]
,
status:
{
Description: Status of the payment method. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
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 2021-10-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: The properties of a payment method. ,
Required: False ,
}
{
family:
{
Description: The family of payment method. ,
Enum:
{
CreditCard: No description available. ,
CheckWire: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type 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 ,
expiration:
{
Description: The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
lastFourDigits:
{
Description: Last four digits of payment method. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the 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 ,
}
,
]
,
status:
{
Description: Status of the payment method. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
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 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of payment method links. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a payment method link. ,
Required: False ,
}
{
paymentMethod:
{
Description: Projection of a payment method ,
Required: False ,
}
{
id:
{
Description: Id of payment method. ,
Required: False ,
}
string ,
family:
{
Description: The family of payment method. ,
Enum:
{
CreditCard: No description available. ,
CheckWire: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type 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 ,
expiration:
{
Description: The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
lastFourDigits:
{
Description: Last four digits of payment method. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the 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 ,
}
,
]
,
status:
{
Description: Status of the payment method. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
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 2021-10-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a payment method link. ,
Required: False ,
}
{
paymentMethod:
{
Description: Projection of a payment method ,
Required: False ,
}
{
id:
{
Description: Id of payment method. ,
Required: False ,
}
string ,
family:
{
Description: The family of payment method. ,
Enum:
{
CreditCard: No description available. ,
CheckWire: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: The type 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 ,
expiration:
{
Description: The expiration month and year of the payment method. This is only supported for payment methods with family CreditCard. ,
Required: False ,
}
string ,
lastFourDigits:
{
Description: Last four digits of payment method. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the 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 ,
}
,
]
,
status:
{
Description: Status of the payment method. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/paymentMethodLinks/{paymentMethodName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2021-10-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 ,
paymentMethodName:
{
Description: The ID that uniquely identifies a payment method. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (202)

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

⚐ Response (409)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
details:
{
Description: The list of detach payment method eligibility errors. ,
Required: False ,
}
[
{
code:
{
Description: Error code for the detach payment method eligibility validation. ,
Enum:
{
AzureSubscriptions: No description available. ,
RecurringCharges: No description available. ,
ReservedInstances: No description available. ,
OutstandingCharges: No description available. ,
PendingCharges: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Error message for the detach payment method eligibility validation. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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