Microsoft.BillingBenefits (preview:2025-05-01)

2025/11/14 • 60 new methods

Operations_List (new)
Description :  List all the operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.BillingBenefits/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SavingsPlanOrderAlias_Create (new)
Description :  Create a savings plan. Learn more about permissions needed at https://go.microsoft.com/fwlink/?linkid=2215851
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.BillingBenefits/savingsPlanOrderAliases/{savingsPlanOrderAliasName}
{
savingsPlanOrderAliasName:
{
Description: Name of the savings plan order alias ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Request body for creating a savings plan order alias ,
Required: True ,
}
{
sku:
{
Description: Savings plan SKU ,
Required: True ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
kind:
{
Description: Resource provider kind ,
Required: False ,
}
string ,
properties:
{
Description: Savings plan order alias properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
savingsPlanOrderId:
{
Description: Identifier of the savings plan created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing the benefit ,
Required: False ,
}
string ,
term:
{
Description: Represent benefit term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
sku:
{
Description: Savings plan SKU ,
Required: True ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
kind:
{
Description: Resource provider kind ,
Required: False ,
}
string ,
properties:
{
Description: Savings plan order alias properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
savingsPlanOrderId:
{
Description: Identifier of the savings plan created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing the benefit ,
Required: False ,
}
string ,
term:
{
Description: Represent benefit term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}
,
$schema:
{
Description: Savings plan order alias ,
}
{
sku:
{
Description: Savings plan SKU ,
Required: True ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
kind:
{
Description: Resource provider kind ,
Required: False ,
}
string ,
properties:
{
Description: Savings plan order alias properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
savingsPlanOrderId:
{
Description: Identifier of the savings plan created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing the benefit ,
Required: False ,
}
string ,
term:
{
Description: Represent benefit term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.BillingBenefits/savingsPlanOrderAliases/{savingsPlanOrderAliasName}
{
savingsPlanOrderAliasName:
{
Description: Name of the savings plan order alias ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: Savings plan SKU ,
Required: True ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
kind:
{
Description: Resource provider kind ,
Required: False ,
}
string ,
properties:
{
Description: Savings plan order alias properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
savingsPlanOrderId:
{
Description: Identifier of the savings plan created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing the benefit ,
Required: False ,
}
string ,
term:
{
Description: Represent benefit term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}
{
savingsPlanOrderId:
{
Description: Order ID of the savings plan ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the detail information of some properties. ,
Required: False ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SavingsPlanOrder_Elevate (new)
Description :  Elevate as owner on savings plan order based on billing permissions.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/elevate
{
savingsPlanOrderId:
{
Description: Order ID of the savings plan ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Role assignment entity id ,
Required: False ,
}
string ,
name:
{
Description: Role assignment entity name ,
Required: False ,
}
string ,
properties:
{
Description: Role assignment entity properties ,
Required: False ,
}
{
principalId:
{
Description: Principal Id ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: Role definition id ,
Required: False ,
}
string ,
scope:
{
Description: Scope of the role assignment entity ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.BillingBenefits/savingsPlanOrders
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans
{
savingsPlanOrderId:
{
Description: Order ID of the savings plan ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.BillingBenefits/savingsPlans
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter by reservation properties. The filter supports 'eq', 'or', and 'and'. It does not currently support 'ne', 'gt', 'le', 'ge', or 'not'. Reservation properties include sku/name, properties/{appliedScopeType, archived, displayName, displayProvisioningState, effectiveDateTime, expiryDate, provisioningState, quantity, renew, reservedResourceType, term, userFriendlyAppliedScopeType, userFriendlyRenewState} ,
Required: False ,
}
string ,
$orderby:
{
Description: May be used to sort order by reservation properties. ,
Required: False ,
}
string ,
refreshSummary:
{
Description: To indicate whether to refresh the roll up counts of the savings plans group by provisioning states ,
Required: False ,
}
string ,
$skiptoken:
{
Description: The number of savings plans to skip from the list before returning results ,
Required: False ,
}
number ,
selectedState:
{
Description: The selected provisioning state ,
Required: False ,
}
string ,
take:
{
Description: To number of savings plans to return ,
Required: False ,
}
number ,
}

⚐ Response (200)

{
value:
{
Description: The list of savings plans. ,
Required: False ,
}
[
{
sku:
{
Description: Savings plan SKU ,
Required: True ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Savings plan properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
displayProvisioningState:
{
Description: The provisioning state of the savings plan for display, e.g. Succeeded ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing the benefit ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Fully-qualified identifier of the billing profile where the benefit is applied. Present only for Field-led or Customer-led customers. ,
Format: arm-id ,
Required: False ,
}
string ,
customerId:
{
Description: Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers. ,
Format: arm-id ,
Required: False ,
}
string ,
billingAccountId:
{
Description: Fully-qualified identifier of the billing account where the benefit is applied. Present only for Enterprise Agreement customers. ,
Format: arm-id ,
Required: False ,
}
string ,
term:
{
Description: Represent benefit term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the savings plan for display, e.g. Shared ,
Required: False ,
}
string ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
effectiveDateTime:
{
Description: DateTime of the savings plan starts providing benefit from. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDateTime:
{
Description: Expiry date time ,
Format: date-time ,
Required: False ,
}
string ,
purchaseDateTime:
{
Description: Date time when the savings plan was purchased ,
Format: date-time ,
Required: False ,
}
string ,
benefitStartTime:
{
Description: This is the DateTime when the savings plan benefit started. ,
Format: date-time ,
Required: False ,
}
string ,
extendedStatusInfo:
{
Required: False ,
}
{
statusCode:
{
Description: Status code providing additional information. ,
Required: False ,
}
string ,
message:
{
Description: The message giving detailed information about the status code. ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
utilization:
{
Description: Savings plan utilization ,
Required: False ,
}
{
trend:
{
Description: The number of days trend for a savings plan ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a savings plan's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
renewSource:
{
Description: SavingsPlan Id of the SavingsPlan from which this SavingsPlan is renewed. ,
Required: False ,
}
string ,
renewDestination:
{
Description: SavingsPlan Id of the SavingsPlan which is purchased because of renew. ,
Required: False ,
}
string ,
renewProperties:
{
Required: False ,
}
{
purchaseProperties:
{
Required: False ,
}
{
sku:
{
Description: The SKU to be applied for this resource ,
Required: False ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
displayName:
{
Description: Friendly name of the savings plan ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing the benefit ,
Required: False ,
}
string ,
term:
{
Description: Represent benefit term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
effectiveDateTime:
{
Description: DateTime of the savings plan starts providing benefit from. ,
Format: date-time ,
Required: False ,
}
string ,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Url to get the next page. ,
Required: False ,
}
string ,
additionalProperties:
{
Description: The roll out count summary of the savings plans ,
Required: False ,
}
[
{
name:
{
Description: This property has value 'summary' ,
Required: False ,
}
string ,
value:
{
Description: The roll up count summary of savings plans in each state ,
Required: False ,
}
{
succeededCount:
{
Description: The number of savings plans in Succeeded state ,
Required: False ,
}
number ,
failedCount:
{
Description: The number of savings plans in Failed state ,
Required: False ,
}
number ,
expiringCount:
{
Description: The number of savings plans in Expiring state ,
Required: False ,
}
number ,
expiredCount:
{
Description: The number of savings plans in Expired state ,
Required: False ,
}
number ,
pendingCount:
{
Description: The number of savings plans in Pending state ,
Required: False ,
}
number ,
cancelledCount:
{
Description: The number of savings plans in Cancelled state ,
Required: False ,
}
number ,
processingCount:
{
Description: The number of savings plans in Processing state ,
Required: False ,
}
number ,
noBenefitCount:
{
Description: The number of savings plans in No Benefit state ,
Required: False ,
}
number ,
warningCount:
{
Description: The number of savings plans in Warning state ,
Required: False ,
}
number ,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}
{
savingsPlanOrderId:
{
Description: Order ID of the savings plan ,
Required: True ,
}
string ,
savingsPlanId:
{
Description: ID of the savings plan ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the detail information of some properties. ,
Required: False ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

PATCH:  /providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}
{
savingsPlanOrderId:
{
Description: Order ID of the savings plan ,
Required: True ,
}
string ,
savingsPlanId:
{
Description: ID of the savings plan ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Request body for patching a savings plan order alias ,
Required: True ,
}
{
properties:
{
Description: Savings plan patch request ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
renewProperties:
{
Required: False ,
}
{
purchaseProperties:
{
Required: False ,
}
{
sku:
{
Description: The SKU to be applied for this resource ,
Required: False ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
displayName:
{
Description: Friendly name of the savings plan ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing the benefit ,
Required: False ,
}
string ,
term:
{
Description: Represent benefit term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
effectiveDateTime:
{
Description: DateTime of the savings plan starts providing benefit from. ,
Format: date-time ,
Required: False ,
}
string ,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

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

⚐ Response (202)

{
location: string ,
}

⚐ Response (404)

{}

⚐ Response (default)

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

⚼ Request

POST:  /providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/validate
{
savingsPlanOrderId:
{
Description: Order ID of the savings plan ,
Required: True ,
}
string ,
savingsPlanId:
{
Description: ID of the savings plan ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Request body for validating a savings plan patch request ,
Required: True ,
}
{
benefits:
{
Required: False ,
}
[
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
renewProperties:
{
Required: False ,
}
{
purchaseProperties:
{
Required: False ,
}
{
sku:
{
Description: The SKU to be applied for this resource ,
Required: False ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
displayName:
{
Description: Friendly name of the savings plan ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing the benefit ,
Required: False ,
}
string ,
term:
{
Description: Represent benefit term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
effectiveDateTime:
{
Description: DateTime of the savings plan starts providing benefit from. ,
Format: date-time ,
Required: False ,
}
string ,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}
,
]
,
}
,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Benefit_Validate (new)
Description :  Validate any benefit.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.BillingBenefits/validate
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Request body for validating a benefit ,
Required: True ,
}
{
benefits:
{
Description: Defines benefits for validation. ,
Required: False ,
}
[
{
benefitType:
{
Description: Type of benefit to validate. This is used to determine the model type for validation. ,
Enum:
{
SavingsPlan: No description available. ,
MACC: No description available. ,
ConditionalCredits: No description available. ,
Credits: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (200)

{
benefits:
{
Description: Defines benefit validation response for benefits. ,
Required: False ,
}
[
{
valid:
{
Description: Indicates if the provided input was valid ,
Required: False ,
}
boolean ,
reasonCode:
{
Description: Failure reason code if the provided input was invalid ,
Required: False ,
}
string ,
reason:
{
Description: Failure reason if the provided input was invalid ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource identifier of the benefit that was validated. ,
Format: arm-id ,
Required: False ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the credit which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Url to get the next page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReservationOrderAlias_Create (new)
Description :  Create a reservation order alias.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.BillingBenefits/reservationOrderAliases/{reservationOrderAliasName}
{
reservationOrderAliasName:
{
Description: Name of the reservation order alias ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Request body for creating a reservation order alias ,
Required: True ,
}
{
sku:
{
Description: Reservation order SKU ,
Required: True ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure Region where the reservation benefits are applied to. ,
Required: False ,
}
string ,
properties:
{
Description: Reservation order alias request properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing the benefit ,
Required: False ,
}
string ,
term:
{
Description: Represent benefit term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Total Quantity of the SKUs purchased in the Reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceType:
{
Description: The type of the resource that is being reserved. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
reviewDateTime:
{
Description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (200)

{
sku:
{
Description: Reservation order SKU ,
Required: True ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure Region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Reservation order alias response properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
reservationOrderId:
{
Description: Identifier of the reservation order created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing the benefit ,
Required: False ,
}
string ,
term:
{
Description: Represent benefit term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Total Quantity of the SKUs purchased in the Reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceType:
{
Description: The type of the resource that is being reserved. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
reviewDateTime:
{
Description: This is the date-time when the Reservation needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}
,
$schema:
{
Description: Reservation order alias ,
}
{
sku:
{
Description: Reservation order SKU ,
Required: True ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure Region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Reservation order alias response properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
reservationOrderId:
{
Description: Identifier of the reservation order created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing the benefit ,
Required: False ,
}
string ,
term:
{
Description: Represent benefit term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Total Quantity of the SKUs purchased in the Reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceType:
{
Description: The type of the resource that is being reserved. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
reviewDateTime:
{
Description: This is the date-time when the Reservation needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ReservationOrderAlias_Get (new)
Description :  Get a reservation order alias.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.BillingBenefits/reservationOrderAliases/{reservationOrderAliasName}
{
reservationOrderAliasName:
{
Description: Name of the reservation order alias ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: Reservation order SKU ,
Required: True ,
}
{
name:
{
Description: Name of the SKU to be applied ,
Required: False ,
}
string ,
}
,
location:
{
Description: The Azure Region where the reserved resource lives. ,
Required: False ,
}
string ,
properties:
{
Description: Reservation order alias response properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
reservationOrderId:
{
Description: Identifier of the reservation order created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingScopeId:
{
Description: Subscription that will be charged for purchasing the benefit ,
Required: False ,
}
string ,
term:
{
Description: Represent benefit term in ISO 8601 format. ,
Enum:
{
P1Y: No description available. ,
P3Y: No description available. ,
P5Y: No description available. ,
}
,
Required: False ,
}
enum ,
billingPlan:
{
Description: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans. ,
Enum:
{
P1M: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeType:
{
Description: Type of the Applied Scope. ,
Enum:
{
Single: No description available. ,
Shared: No description available. ,
ManagementGroup: No description available. ,
}
,
Required: False ,
}
enum ,
appliedScopeProperties:
{
Description: Properties specific to applied scope type. Not required if not applicable. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant ID where the benefit is applied. ,
Required: False ,
}
string ,
managementGroupId:
{
Description: Fully-qualified identifier of the management group where the benefit must be applied. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Fully-qualified identifier of the subscription. ,
Required: False ,
}
string ,
resourceGroupId:
{
Description: Fully-qualified identifier of the resource group. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
quantity:
{
Description: Total Quantity of the SKUs purchased in the Reservation. ,
Format: int32 ,
Required: False ,
}
integer ,
renew:
{
Description: Setting this to true will automatically purchase a new benefit on the expiration date time. ,
Required: False ,
}
boolean ,
reservedResourceType:
{
Description: The type of the resource that is being reserved. ,
Enum:
{
VirtualMachines: No description available. ,
SqlDatabases: No description available. ,
SuseLinux: No description available. ,
CosmosDb: No description available. ,
RedHat: No description available. ,
SqlDataWarehouse: No description available. ,
VMwareCloudSimple: No description available. ,
RedHatOsa: No description available. ,
Databricks: No description available. ,
AppService: No description available. ,
ManagedDisk: No description available. ,
BlockBlob: No description available. ,
RedisCache: No description available. ,
AzureDataExplorer: No description available. ,
MySql: No description available. ,
MariaDb: No description available. ,
PostgreSql: No description available. ,
DedicatedHost: No description available. ,
SapHana: No description available. ,
SqlAzureHybridBenefit: No description available. ,
AVS: No description available. ,
DataFactory: No description available. ,
NetAppStorage: No description available. ,
AzureFiles: No description available. ,
SqlEdge: No description available. ,
VirtualMachineSoftware: No description available. ,
}
,
Required: False ,
}
enum ,
reviewDateTime:
{
Description: This is the date-time when the Reservation needs to be reviewed. ,
Format: date-time ,
Required: False ,
}
string ,
reservedResourceProperties:
{
Description: Properties specific to each reserved resource type. Not required if not applicable. ,
Required: False ,
}
{
instanceFlexibility:
{
Description: Turning this on will apply the reservation discount to other VMs in the same VM size group. ,
Enum:
{
On: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Discounts_Create (new)
Description :  Create discount.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/discounts/{discountName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
discountName:
{
Description: Name of the discount ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Request body for creating a discount. ,
Required: True ,
}
{
properties:
{
Description: Discount properties ,
Required: False ,
}
{
entityType:
{
Description: This defines whether the entity being created is primary or affiliate. Supported values: primary, affiliate. Validation: Required, must match one of the 2 values. ,
Enum:
{
Primary: No description available. ,
Affiliate: No description available. ,
}
,
Required: True ,
}
enum ,
productCode:
{
Description: This is the catalog UPN for the product. ,
Required: True ,
}
string ,
startAt:
{
Description: Start date of the discount. Value is the date the discount started or will start in the future. ,
Format: date-time ,
Required: True ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the Discount which will not change for the lifetime of the Discount. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the resource. Supported values are Pending, Failed, Succeeded, Canceled. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountResourceId:
{
Description: Billing account resource id where the discount metadata is present. ,
Format: arm-id ,
Required: False ,
}
string ,
billingProfileResourceId:
{
Description: Billing profile resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
customerResourceId:
{
Description: Customer resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
displayName:
{
Description: This defines a user friendly display name for the discount. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the discount. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
benefitResourceId:
{
Description: Fully-qualified identifier of the benefit under applicable benefit list. ,
Format: arm-id ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: List of applied scopes supported for discounts. ,
Enum:
{
BillingAccount: No description available. ,
BillingProfile: No description available. ,
Customer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Discount properties ,
Required: False ,
}
{
entityType:
{
Description: This defines whether the entity being created is primary or affiliate. Supported values: primary, affiliate. Validation: Required, must match one of the 2 values. ,
Enum:
{
Primary: No description available. ,
Affiliate: No description available. ,
}
,
Required: True ,
}
enum ,
productCode:
{
Description: This is the catalog UPN for the product. ,
Required: True ,
}
string ,
startAt:
{
Description: Start date of the discount. Value is the date the discount started or will start in the future. ,
Format: date-time ,
Required: True ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the Discount which will not change for the lifetime of the Discount. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the resource. Supported values are Pending, Failed, Succeeded, Canceled. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountResourceId:
{
Description: Billing account resource id where the discount metadata is present. ,
Format: arm-id ,
Required: False ,
}
string ,
billingProfileResourceId:
{
Description: Billing profile resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
customerResourceId:
{
Description: Customer resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
displayName:
{
Description: This defines a user friendly display name for the discount. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the discount. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
benefitResourceId:
{
Description: Fully-qualified identifier of the benefit under applicable benefit list. ,
Format: arm-id ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: List of applied scopes supported for discounts. ,
Enum:
{
BillingAccount: No description available. ,
BillingProfile: No description available. ,
Customer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}
,
$schema:
{
Description: Resource definition for Discounts. ,
}
{
properties:
{
Description: Discount properties ,
Required: False ,
}
{
entityType:
{
Description: This defines whether the entity being created is primary or affiliate. Supported values: primary, affiliate. Validation: Required, must match one of the 2 values. ,
Enum:
{
Primary: No description available. ,
Affiliate: No description available. ,
}
,
Required: True ,
}
enum ,
productCode:
{
Description: This is the catalog UPN for the product. ,
Required: True ,
}
string ,
startAt:
{
Description: Start date of the discount. Value is the date the discount started or will start in the future. ,
Format: date-time ,
Required: True ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the Discount which will not change for the lifetime of the Discount. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the resource. Supported values are Pending, Failed, Succeeded, Canceled. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountResourceId:
{
Description: Billing account resource id where the discount metadata is present. ,
Format: arm-id ,
Required: False ,
}
string ,
billingProfileResourceId:
{
Description: Billing profile resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
customerResourceId:
{
Description: Customer resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
displayName:
{
Description: This defines a user friendly display name for the discount. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the discount. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
benefitResourceId:
{
Description: Fully-qualified identifier of the benefit under applicable benefit list. ,
Format: arm-id ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: List of applied scopes supported for discounts. ,
Enum:
{
BillingAccount: No description available. ,
BillingProfile: No description available. ,
Customer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Discounts_Delete (new)
Description :  Delete discount. Clears the metadata from the user's view.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/discounts/{discountName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
discountName:
{
Description: Name of the discount ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result. ,
}
string ,
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Discount_Get (new)
Description :  Get discount at resource group level
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/discounts/{discountName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
discountName:
{
Description: Name of the discount ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Discount properties ,
Required: False ,
}
{
entityType:
{
Description: This defines whether the entity being created is primary or affiliate. Supported values: primary, affiliate. Validation: Required, must match one of the 2 values. ,
Enum:
{
Primary: No description available. ,
Affiliate: No description available. ,
}
,
Required: True ,
}
enum ,
productCode:
{
Description: This is the catalog UPN for the product. ,
Required: True ,
}
string ,
startAt:
{
Description: Start date of the discount. Value is the date the discount started or will start in the future. ,
Format: date-time ,
Required: True ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the Discount which will not change for the lifetime of the Discount. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the resource. Supported values are Pending, Failed, Succeeded, Canceled. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountResourceId:
{
Description: Billing account resource id where the discount metadata is present. ,
Format: arm-id ,
Required: False ,
}
string ,
billingProfileResourceId:
{
Description: Billing profile resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
customerResourceId:
{
Description: Customer resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
displayName:
{
Description: This defines a user friendly display name for the discount. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the discount. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
benefitResourceId:
{
Description: Fully-qualified identifier of the benefit under applicable benefit list. ,
Format: arm-id ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: List of applied scopes supported for discounts. ,
Enum:
{
BillingAccount: No description available. ,
BillingProfile: No description available. ,
Customer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/discounts/{discountName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
discountName:
{
Description: Name of the discount ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Request body for updating discounts ,
Required: True ,
}
{
properties:
{
Description: Discounts patch request properties ,
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Discount properties ,
Required: False ,
}
{
entityType:
{
Description: This defines whether the entity being created is primary or affiliate. Supported values: primary, affiliate. Validation: Required, must match one of the 2 values. ,
Enum:
{
Primary: No description available. ,
Affiliate: No description available. ,
}
,
Required: True ,
}
enum ,
productCode:
{
Description: This is the catalog UPN for the product. ,
Required: True ,
}
string ,
startAt:
{
Description: Start date of the discount. Value is the date the discount started or will start in the future. ,
Format: date-time ,
Required: True ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the Discount which will not change for the lifetime of the Discount. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the resource. Supported values are Pending, Failed, Succeeded, Canceled. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountResourceId:
{
Description: Billing account resource id where the discount metadata is present. ,
Format: arm-id ,
Required: False ,
}
string ,
billingProfileResourceId:
{
Description: Billing profile resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
customerResourceId:
{
Description: Customer resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
displayName:
{
Description: This defines a user friendly display name for the discount. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the discount. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
benefitResourceId:
{
Description: Fully-qualified identifier of the benefit under applicable benefit list. ,
Format: arm-id ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: List of applied scopes supported for discounts. ,
Enum:
{
BillingAccount: No description available. ,
BillingProfile: No description available. ,
Customer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
location:
{
Description: Location URI to poll for result. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Discounts_ResourceGroupList (new)
Description :  List discounts at resource group level
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/discounts
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of discounts. ,
Required: False ,
}
[
{
properties:
{
Description: Discount properties ,
Required: False ,
}
{
entityType:
{
Description: This defines whether the entity being created is primary or affiliate. Supported values: primary, affiliate. Validation: Required, must match one of the 2 values. ,
Enum:
{
Primary: No description available. ,
Affiliate: No description available. ,
}
,
Required: True ,
}
enum ,
productCode:
{
Description: This is the catalog UPN for the product. ,
Required: True ,
}
string ,
startAt:
{
Description: Start date of the discount. Value is the date the discount started or will start in the future. ,
Format: date-time ,
Required: True ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the Discount which will not change for the lifetime of the Discount. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the resource. Supported values are Pending, Failed, Succeeded, Canceled. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountResourceId:
{
Description: Billing account resource id where the discount metadata is present. ,
Format: arm-id ,
Required: False ,
}
string ,
billingProfileResourceId:
{
Description: Billing profile resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
customerResourceId:
{
Description: Customer resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
displayName:
{
Description: This defines a user friendly display name for the discount. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the discount. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
benefitResourceId:
{
Description: Fully-qualified identifier of the benefit under applicable benefit list. ,
Format: arm-id ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: List of applied scopes supported for discounts. ,
Enum:
{
BillingAccount: No description available. ,
BillingProfile: No description available. ,
Customer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Url to get the next page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Discounts_SubscriptionList (new)
Description :  List discounts at subscription level
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.BillingBenefits/discounts
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of discounts. ,
Required: False ,
}
[
{
properties:
{
Description: Discount properties ,
Required: False ,
}
{
entityType:
{
Description: This defines whether the entity being created is primary or affiliate. Supported values: primary, affiliate. Validation: Required, must match one of the 2 values. ,
Enum:
{
Primary: No description available. ,
Affiliate: No description available. ,
}
,
Required: True ,
}
enum ,
productCode:
{
Description: This is the catalog UPN for the product. ,
Required: True ,
}
string ,
startAt:
{
Description: Start date of the discount. Value is the date the discount started or will start in the future. ,
Format: date-time ,
Required: True ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the Discount which will not change for the lifetime of the Discount. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the resource. Supported values are Pending, Failed, Succeeded, Canceled. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountResourceId:
{
Description: Billing account resource id where the discount metadata is present. ,
Format: arm-id ,
Required: False ,
}
string ,
billingProfileResourceId:
{
Description: Billing profile resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
customerResourceId:
{
Description: Customer resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
displayName:
{
Description: This defines a user friendly display name for the discount. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the discount. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
benefitResourceId:
{
Description: Fully-qualified identifier of the benefit under applicable benefit list. ,
Format: arm-id ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: List of applied scopes supported for discounts. ,
Enum:
{
BillingAccount: No description available. ,
BillingProfile: No description available. ,
Customer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Url to get the next page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Discounts_Cancel (new)
Description :  Cancel discount. Stops applying the benefit.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/discounts/{discountName}/cancel
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
discountName:
{
Description: Name of the discount ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result. ,
}
string ,
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}

⚐ Response (200)

{
properties:
{
Description: Discount properties ,
Required: False ,
}
{
entityType:
{
Description: This defines whether the entity being created is primary or affiliate. Supported values: primary, affiliate. Validation: Required, must match one of the 2 values. ,
Enum:
{
Primary: No description available. ,
Affiliate: No description available. ,
}
,
Required: True ,
}
enum ,
productCode:
{
Description: This is the catalog UPN for the product. ,
Required: True ,
}
string ,
startAt:
{
Description: Start date of the discount. Value is the date the discount started or will start in the future. ,
Format: date-time ,
Required: True ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the Discount which will not change for the lifetime of the Discount. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the resource. Supported values are Pending, Failed, Succeeded, Canceled. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountResourceId:
{
Description: Billing account resource id where the discount metadata is present. ,
Format: arm-id ,
Required: False ,
}
string ,
billingProfileResourceId:
{
Description: Billing profile resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
customerResourceId:
{
Description: Customer resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
displayName:
{
Description: This defines a user friendly display name for the discount. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the discount. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
benefitResourceId:
{
Description: Fully-qualified identifier of the benefit under applicable benefit list. ,
Format: arm-id ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: List of applied scopes supported for discounts. ,
Enum:
{
BillingAccount: No description available. ,
BillingProfile: No description available. ,
Customer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Discounts_ScopeList (new)
Description :  List discounts that are applicable for a given scope. Currently supported scopes: billing accounts
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.BillingBenefits/applicableDiscounts
{
scope:
{
Description: The scope at which the benefits are listed. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of discounts. ,
Required: False ,
}
[
{
properties:
{
Description: Discount properties ,
Required: False ,
}
{
entityType:
{
Description: This defines whether the entity being created is primary or affiliate. Supported values: primary, affiliate. Validation: Required, must match one of the 2 values. ,
Enum:
{
Primary: No description available. ,
Affiliate: No description available. ,
}
,
Required: True ,
}
enum ,
productCode:
{
Description: This is the catalog UPN for the product. ,
Required: True ,
}
string ,
startAt:
{
Description: Start date of the discount. Value is the date the discount started or will start in the future. ,
Format: date-time ,
Required: True ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the Discount which will not change for the lifetime of the Discount. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the resource. Supported values are Pending, Failed, Succeeded, Canceled. ,
Enum:
{
Unknown: No description available. ,
Pending: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
billingAccountResourceId:
{
Description: Billing account resource id where the discount metadata is present. ,
Format: arm-id ,
Required: False ,
}
string ,
billingProfileResourceId:
{
Description: Billing profile resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
customerResourceId:
{
Description: Customer resource id where the discount is scoped to. ,
Format: arm-id ,
Required: False ,
}
string ,
displayName:
{
Description: This defines a user friendly display name for the discount. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the discount. ,
Enum:
{
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
benefitResourceId:
{
Description: Fully-qualified identifier of the benefit under applicable benefit list. ,
Format: arm-id ,
Required: False ,
}
string ,
appliedScopeType:
{
Description: List of applied scopes supported for discounts. ,
Enum:
{
BillingAccount: No description available. ,
BillingProfile: No description available. ,
Customer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Url to get the next page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Maccs_Create (new)
Description :  Create MACC.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
maccName:
{
Description: Name of primary MACC. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Request body for creating MACC. ,
Required: True ,
}
{
properties:
{
Description: MACC properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of MACC as assigned by RPaaS. This indicates the last operation's status. For all practical purposes, this can be ignored. For current status of MACC resource, refer to MaccStatus. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the MACC. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Stopped: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
entityType:
{
Description: Represents type of the object being operated on. Possible values are primary or contributor. ,
Enum:
{
Primary: No description available. ,
Contributor: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
billingAccountResourceId:
{
Description: Fully-qualified identifier of the billing account where the MACC is applied. Present only for Enterprise Agreement customers. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId} ,
Format: arm-id ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Must be start of month. Timestamp must be in the ISO date format YYYY-MM-DDT00:00:00Z. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: Must be end of month. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the MACC which will not change for the lifetime of the MACC. ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall charging when commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
shortfall:
{
Description: MACC shortfall ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
milestones:
{
Description: List of milestones associated with this MACC. ,
Required: False ,
}
[
{
milestoneId:
{
Description: Globally unique identifier for the milestone. Format: {guid} ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment associated with this milestone. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
endAt:
{
Description: End date time for the milestone. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall invoicing when milestone commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Represents the current status of the Milestone. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Completed: No description available. ,
Canceled: No description available. ,
Removed: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
shortfall:
{
Description: Details of the shortfall associated with this milestone. ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resourceId:
{
Description: This is the resource identifier of either the primary MACC or the contributor. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
allowContributors:
{
Description: Setting this to true means multi-entity. ,
Required: False ,
}
boolean ,
primaryResourceId:
{
Description: Fully-qualified resource identifier of the primary MACC. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
primaryBillingAccountResourceId:
{
Description: Fully-qualified billing account resource identifier of the primary MACC. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: MACC properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of MACC as assigned by RPaaS. This indicates the last operation's status. For all practical purposes, this can be ignored. For current status of MACC resource, refer to MaccStatus. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the MACC. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Stopped: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
entityType:
{
Description: Represents type of the object being operated on. Possible values are primary or contributor. ,
Enum:
{
Primary: No description available. ,
Contributor: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
billingAccountResourceId:
{
Description: Fully-qualified identifier of the billing account where the MACC is applied. Present only for Enterprise Agreement customers. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId} ,
Format: arm-id ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Must be start of month. Timestamp must be in the ISO date format YYYY-MM-DDT00:00:00Z. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: Must be end of month. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the MACC which will not change for the lifetime of the MACC. ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall charging when commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
shortfall:
{
Description: MACC shortfall ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
milestones:
{
Description: List of milestones associated with this MACC. ,
Required: False ,
}
[
{
milestoneId:
{
Description: Globally unique identifier for the milestone. Format: {guid} ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment associated with this milestone. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
endAt:
{
Description: End date time for the milestone. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall invoicing when milestone commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Represents the current status of the Milestone. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Completed: No description available. ,
Canceled: No description available. ,
Removed: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
shortfall:
{
Description: Details of the shortfall associated with this milestone. ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resourceId:
{
Description: This is the resource identifier of either the primary MACC or the contributor. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
allowContributors:
{
Description: Setting this to true means multi-entity. ,
Required: False ,
}
boolean ,
primaryResourceId:
{
Description: Fully-qualified resource identifier of the primary MACC. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
primaryBillingAccountResourceId:
{
Description: Fully-qualified billing account resource identifier of the primary MACC. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}
,
$schema:
{
Description: Microsoft Azure Consumption Commitment. ,
}
{
properties:
{
Description: MACC properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of MACC as assigned by RPaaS. This indicates the last operation's status. For all practical purposes, this can be ignored. For current status of MACC resource, refer to MaccStatus. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the MACC. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Stopped: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
entityType:
{
Description: Represents type of the object being operated on. Possible values are primary or contributor. ,
Enum:
{
Primary: No description available. ,
Contributor: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
billingAccountResourceId:
{
Description: Fully-qualified identifier of the billing account where the MACC is applied. Present only for Enterprise Agreement customers. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId} ,
Format: arm-id ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Must be start of month. Timestamp must be in the ISO date format YYYY-MM-DDT00:00:00Z. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: Must be end of month. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the MACC which will not change for the lifetime of the MACC. ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall charging when commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
shortfall:
{
Description: MACC shortfall ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
milestones:
{
Description: List of milestones associated with this MACC. ,
Required: False ,
}
[
{
milestoneId:
{
Description: Globally unique identifier for the milestone. Format: {guid} ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment associated with this milestone. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
endAt:
{
Description: End date time for the milestone. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall invoicing when milestone commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Represents the current status of the Milestone. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Completed: No description available. ,
Canceled: No description available. ,
Removed: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
shortfall:
{
Description: Details of the shortfall associated with this milestone. ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resourceId:
{
Description: This is the resource identifier of either the primary MACC or the contributor. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
allowContributors:
{
Description: Setting this to true means multi-entity. ,
Required: False ,
}
boolean ,
primaryResourceId:
{
Description: Fully-qualified resource identifier of the primary MACC. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
primaryBillingAccountResourceId:
{
Description: Fully-qualified billing account resource identifier of the primary MACC. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
maccName:
{
Description: Name of primary MACC. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: MACC properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of MACC as assigned by RPaaS. This indicates the last operation's status. For all practical purposes, this can be ignored. For current status of MACC resource, refer to MaccStatus. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the MACC. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Stopped: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
entityType:
{
Description: Represents type of the object being operated on. Possible values are primary or contributor. ,
Enum:
{
Primary: No description available. ,
Contributor: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
billingAccountResourceId:
{
Description: Fully-qualified identifier of the billing account where the MACC is applied. Present only for Enterprise Agreement customers. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId} ,
Format: arm-id ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Must be start of month. Timestamp must be in the ISO date format YYYY-MM-DDT00:00:00Z. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: Must be end of month. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the MACC which will not change for the lifetime of the MACC. ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall charging when commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
shortfall:
{
Description: MACC shortfall ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
milestones:
{
Description: List of milestones associated with this MACC. ,
Required: False ,
}
[
{
milestoneId:
{
Description: Globally unique identifier for the milestone. Format: {guid} ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment associated with this milestone. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
endAt:
{
Description: End date time for the milestone. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall invoicing when milestone commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Represents the current status of the Milestone. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Completed: No description available. ,
Canceled: No description available. ,
Removed: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
shortfall:
{
Description: Details of the shortfall associated with this milestone. ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resourceId:
{
Description: This is the resource identifier of either the primary MACC or the contributor. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
allowContributors:
{
Description: Setting this to true means multi-entity. ,
Required: False ,
}
boolean ,
primaryResourceId:
{
Description: Fully-qualified resource identifier of the primary MACC. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
primaryBillingAccountResourceId:
{
Description: Fully-qualified billing account resource identifier of the primary MACC. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
maccName:
{
Description: Name of primary MACC. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Request body for updating MACC. ,
Required: True ,
}
{
properties:
{
Description: Macc patch request properties ,
Required: False ,
}
{
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
allowContributors:
{
Description: Setting this to true means multi-entity. ,
Required: False ,
}
boolean ,
automaticShortfall:
{
Description: Represents the enablement status of a feature or settings. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the Milestone. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Completed: No description available. ,
Canceled: No description available. ,
Removed: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
milestones:
{
Description: List of milestones to update or add. ,
Required: False ,
}
[
{
milestoneId:
{
Description: Globally unique identifier for the milestone. Format: {guid} ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment associated with this milestone. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
endAt:
{
Description: End date time for the milestone. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall invoicing when milestone commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Represents the current status of the Milestone. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Completed: No description available. ,
Canceled: No description available. ,
Removed: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
shortfall:
{
Description: Details of the shortfall associated with this milestone. ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
}
,
]
,
primaryResourceId:
{
Description: Fully-qualified resource identifier of the primary MACC. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
primaryBillingAccountResourceId:
{
Description: Fully-qualified billing account resource identifier of the primary MACC. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: MACC properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of MACC as assigned by RPaaS. This indicates the last operation's status. For all practical purposes, this can be ignored. For current status of MACC resource, refer to MaccStatus. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the MACC. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Stopped: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
entityType:
{
Description: Represents type of the object being operated on. Possible values are primary or contributor. ,
Enum:
{
Primary: No description available. ,
Contributor: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
billingAccountResourceId:
{
Description: Fully-qualified identifier of the billing account where the MACC is applied. Present only for Enterprise Agreement customers. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId} ,
Format: arm-id ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Must be start of month. Timestamp must be in the ISO date format YYYY-MM-DDT00:00:00Z. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: Must be end of month. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the MACC which will not change for the lifetime of the MACC. ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall charging when commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
shortfall:
{
Description: MACC shortfall ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
milestones:
{
Description: List of milestones associated with this MACC. ,
Required: False ,
}
[
{
milestoneId:
{
Description: Globally unique identifier for the milestone. Format: {guid} ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment associated with this milestone. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
endAt:
{
Description: End date time for the milestone. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall invoicing when milestone commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Represents the current status of the Milestone. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Completed: No description available. ,
Canceled: No description available. ,
Removed: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
shortfall:
{
Description: Details of the shortfall associated with this milestone. ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resourceId:
{
Description: This is the resource identifier of either the primary MACC or the contributor. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
allowContributors:
{
Description: Setting this to true means multi-entity. ,
Required: False ,
}
boolean ,
primaryResourceId:
{
Description: Fully-qualified resource identifier of the primary MACC. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
primaryBillingAccountResourceId:
{
Description: Fully-qualified billing account resource identifier of the primary MACC. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
location:
{
Description: Location URI to poll for result. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Maccs_Delete (new)
Description :  Delete MACC.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
maccName:
{
Description: Name of primary MACC. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result. ,
}
string ,
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Maccs_ListByResourceGroup (new)
Description :  List MACCs under a resource group for primary service admin.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List MACCs. ,
Required: False ,
}
[
{
properties:
{
Description: MACC properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of MACC as assigned by RPaaS. This indicates the last operation's status. For all practical purposes, this can be ignored. For current status of MACC resource, refer to MaccStatus. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the MACC. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Stopped: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
entityType:
{
Description: Represents type of the object being operated on. Possible values are primary or contributor. ,
Enum:
{
Primary: No description available. ,
Contributor: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
billingAccountResourceId:
{
Description: Fully-qualified identifier of the billing account where the MACC is applied. Present only for Enterprise Agreement customers. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId} ,
Format: arm-id ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Must be start of month. Timestamp must be in the ISO date format YYYY-MM-DDT00:00:00Z. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: Must be end of month. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the MACC which will not change for the lifetime of the MACC. ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall charging when commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
shortfall:
{
Description: MACC shortfall ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
milestones:
{
Description: List of milestones associated with this MACC. ,
Required: False ,
}
[
{
milestoneId:
{
Description: Globally unique identifier for the milestone. Format: {guid} ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment associated with this milestone. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
endAt:
{
Description: End date time for the milestone. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall invoicing when milestone commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Represents the current status of the Milestone. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Completed: No description available. ,
Canceled: No description available. ,
Removed: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
shortfall:
{
Description: Details of the shortfall associated with this milestone. ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resourceId:
{
Description: This is the resource identifier of either the primary MACC or the contributor. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
allowContributors:
{
Description: Setting this to true means multi-entity. ,
Required: False ,
}
boolean ,
primaryResourceId:
{
Description: Fully-qualified resource identifier of the primary MACC. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
primaryBillingAccountResourceId:
{
Description: Fully-qualified billing account resource identifier of the primary MACC. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Url to get the next page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Maccs_ListBySubscription (new)
Description :  List MACCs under a subscription from primary service tenant.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.BillingBenefits/maccs
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List MACCs. ,
Required: False ,
}
[
{
properties:
{
Description: MACC properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of MACC as assigned by RPaaS. This indicates the last operation's status. For all practical purposes, this can be ignored. For current status of MACC resource, refer to MaccStatus. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the MACC. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Stopped: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
entityType:
{
Description: Represents type of the object being operated on. Possible values are primary or contributor. ,
Enum:
{
Primary: No description available. ,
Contributor: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
billingAccountResourceId:
{
Description: Fully-qualified identifier of the billing account where the MACC is applied. Present only for Enterprise Agreement customers. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId} ,
Format: arm-id ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Must be start of month. Timestamp must be in the ISO date format YYYY-MM-DDT00:00:00Z. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: Must be end of month. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the MACC which will not change for the lifetime of the MACC. ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall charging when commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
shortfall:
{
Description: MACC shortfall ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
milestones:
{
Description: List of milestones associated with this MACC. ,
Required: False ,
}
[
{
milestoneId:
{
Description: Globally unique identifier for the milestone. Format: {guid} ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment associated with this milestone. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
endAt:
{
Description: End date time for the milestone. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall invoicing when milestone commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Represents the current status of the Milestone. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Completed: No description available. ,
Canceled: No description available. ,
Removed: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
shortfall:
{
Description: Details of the shortfall associated with this milestone. ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resourceId:
{
Description: This is the resource identifier of either the primary MACC or the contributor. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
allowContributors:
{
Description: Setting this to true means multi-entity. ,
Required: False ,
}
boolean ,
primaryResourceId:
{
Description: Fully-qualified resource identifier of the primary MACC. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
primaryBillingAccountResourceId:
{
Description: Fully-qualified billing account resource identifier of the primary MACC. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Url to get the next page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Maccs_Cancel (new)
Description :  Represents an operation to cancel MACC contract. This operation does not indicate deletion of the MACC, but rather stops applying the benefit to the account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}/cancel
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
maccName:
{
Description: Name of primary MACC. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result. ,
}
string ,
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}

⚐ Response (200)

{
properties:
{
Description: MACC properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of MACC as assigned by RPaaS. This indicates the last operation's status. For all practical purposes, this can be ignored. For current status of MACC resource, refer to MaccStatus. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the MACC. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Stopped: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
entityType:
{
Description: Represents type of the object being operated on. Possible values are primary or contributor. ,
Enum:
{
Primary: No description available. ,
Contributor: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
billingAccountResourceId:
{
Description: Fully-qualified identifier of the billing account where the MACC is applied. Present only for Enterprise Agreement customers. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId} ,
Format: arm-id ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Must be start of month. Timestamp must be in the ISO date format YYYY-MM-DDT00:00:00Z. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: Must be end of month. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the MACC which will not change for the lifetime of the MACC. ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall charging when commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
shortfall:
{
Description: MACC shortfall ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
milestones:
{
Description: List of milestones associated with this MACC. ,
Required: False ,
}
[
{
milestoneId:
{
Description: Globally unique identifier for the milestone. Format: {guid} ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment associated with this milestone. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
endAt:
{
Description: End date time for the milestone. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall invoicing when milestone commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Represents the current status of the Milestone. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Completed: No description available. ,
Canceled: No description available. ,
Removed: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
shortfall:
{
Description: Details of the shortfall associated with this milestone. ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resourceId:
{
Description: This is the resource identifier of either the primary MACC or the contributor. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
allowContributors:
{
Description: Setting this to true means multi-entity. ,
Required: False ,
}
boolean ,
primaryResourceId:
{
Description: Fully-qualified resource identifier of the primary MACC. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
primaryBillingAccountResourceId:
{
Description: Fully-qualified billing account resource identifier of the primary MACC. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Maccs_WriteOff (new)
Description :  Operation to waive a customer's pending MACC balance (Shortfall) from their account, ensuring they are not charged for the outstanding amount.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}/writeOff
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
maccName:
{
Description: Name of primary MACC. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result. ,
}
string ,
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}

⚐ Response (200)

{
properties:
{
Description: MACC properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of MACC as assigned by RPaaS. This indicates the last operation's status. For all practical purposes, this can be ignored. For current status of MACC resource, refer to MaccStatus. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the MACC. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Stopped: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
entityType:
{
Description: Represents type of the object being operated on. Possible values are primary or contributor. ,
Enum:
{
Primary: No description available. ,
Contributor: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
billingAccountResourceId:
{
Description: Fully-qualified identifier of the billing account where the MACC is applied. Present only for Enterprise Agreement customers. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId} ,
Format: arm-id ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Must be start of month. Timestamp must be in the ISO date format YYYY-MM-DDT00:00:00Z. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: Must be end of month. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the MACC which will not change for the lifetime of the MACC. ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall charging when commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
shortfall:
{
Description: MACC shortfall ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
milestones:
{
Description: List of milestones associated with this MACC. ,
Required: False ,
}
[
{
milestoneId:
{
Description: Globally unique identifier for the milestone. Format: {guid} ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment associated with this milestone. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
endAt:
{
Description: End date time for the milestone. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall invoicing when milestone commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Represents the current status of the Milestone. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Completed: No description available. ,
Canceled: No description available. ,
Removed: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
shortfall:
{
Description: Details of the shortfall associated with this milestone. ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resourceId:
{
Description: This is the resource identifier of either the primary MACC or the contributor. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
allowContributors:
{
Description: Setting this to true means multi-entity. ,
Required: False ,
}
boolean ,
primaryResourceId:
{
Description: Fully-qualified resource identifier of the primary MACC. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
primaryBillingAccountResourceId:
{
Description: Fully-qualified billing account resource identifier of the primary MACC. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Contributors_GetFromPrimary (new)
Description :  Get a contributor for primary service admin
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}/contributors/{contributorName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
maccName:
{
Description: Name of primary MACC. ,
Required: True ,
}
string ,
contributorName:
{
Description: Unique name of contributor in the format {contributorCloudSubId}_{resourceGroupName}_{nameInContributorTenant}. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: MACC contributor properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of MACC as assigned by RPaaS. This indicates the last operation's status. For all practical purposes, this can be ignored. For current status of MACC resource, refer to MaccStatus. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the MACC. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Stopped: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
entityType:
{
Description: Represents type of the object being operated on. Possible values are primary or contributor. ,
Enum:
{
Primary: No description available. ,
Contributor: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
billingAccountResourceId:
{
Description: Fully-qualified identifier of the billing account where the MACC is applied. Present only for Enterprise Agreement customers. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId} ,
Format: arm-id ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Must be start of month. Timestamp must be in the ISO date format YYYY-MM-DDT00:00:00Z. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: Must be end of month. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the MACC which will not change for the lifetime of the MACC. ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall charging when commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
shortfall:
{
Description: MACC shortfall ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
milestones:
{
Description: List of milestones associated with this MACC. ,
Required: False ,
}
[
{
milestoneId:
{
Description: Globally unique identifier for the milestone. Format: {guid} ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment associated with this milestone. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
endAt:
{
Description: End date time for the milestone. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall invoicing when milestone commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Represents the current status of the Milestone. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Completed: No description available. ,
Canceled: No description available. ,
Removed: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
shortfall:
{
Description: Details of the shortfall associated with this milestone. ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resourceId:
{
Description: This is the resource identifier of either the primary MACC or the contributor. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
allowContributors:
{
Description: Setting this to true means multi-entity. ,
Required: False ,
}
boolean ,
primaryResourceId:
{
Description: Fully-qualified resource identifier of the primary MACC. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
primaryBillingAccountResourceId:
{
Description: Fully-qualified billing account resource identifier of the primary MACC. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Contributors_ListFromPrimary (new)
Description :  List contributors under a MACC for primary service admin
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}/contributors
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
maccName:
{
Description: Name of primary MACC. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: MACC contributor properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of MACC as assigned by RPaaS. This indicates the last operation's status. For all practical purposes, this can be ignored. For current status of MACC resource, refer to MaccStatus. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the MACC. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Stopped: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
entityType:
{
Description: Represents type of the object being operated on. Possible values are primary or contributor. ,
Enum:
{
Primary: No description available. ,
Contributor: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
billingAccountResourceId:
{
Description: Fully-qualified identifier of the billing account where the MACC is applied. Present only for Enterprise Agreement customers. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId} ,
Format: arm-id ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Must be start of month. Timestamp must be in the ISO date format YYYY-MM-DDT00:00:00Z. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: Must be end of month. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the MACC which will not change for the lifetime of the MACC. ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall charging when commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
shortfall:
{
Description: MACC shortfall ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
milestones:
{
Description: List of milestones associated with this MACC. ,
Required: False ,
}
[
{
milestoneId:
{
Description: Globally unique identifier for the milestone. Format: {guid} ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment associated with this milestone. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
endAt:
{
Description: End date time for the milestone. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall invoicing when milestone commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Represents the current status of the Milestone. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Completed: No description available. ,
Canceled: No description available. ,
Removed: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
shortfall:
{
Description: Details of the shortfall associated with this milestone. ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resourceId:
{
Description: This is the resource identifier of either the primary MACC or the contributor. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
allowContributors:
{
Description: Setting this to true means multi-entity. ,
Required: False ,
}
boolean ,
primaryResourceId:
{
Description: Fully-qualified resource identifier of the primary MACC. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
primaryBillingAccountResourceId:
{
Description: Fully-qualified billing account resource identifier of the primary MACC. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Url to get the next page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Maccs_ChargeShortfall (new)
Description :  Operation to charge shortfall to a customer's account, ensuring they are charged for the outstanding amount of MACC credit.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}/chargeShortfall
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
maccName:
{
Description: Name of primary MACC. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Request body for charging shortfall. ,
Required: True ,
}
{
properties:
{
Description: Charge shortfall request properties ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result. ,
}
string ,
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}

⚐ Response (200)

{
properties:
{
Description: MACC properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of MACC as assigned by RPaaS. This indicates the last operation's status. For all practical purposes, this can be ignored. For current status of MACC resource, refer to MaccStatus. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the MACC. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Stopped: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
entityType:
{
Description: Represents type of the object being operated on. Possible values are primary or contributor. ,
Enum:
{
Primary: No description available. ,
Contributor: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
billingAccountResourceId:
{
Description: Fully-qualified identifier of the billing account where the MACC is applied. Present only for Enterprise Agreement customers. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId} ,
Format: arm-id ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Must be start of month. Timestamp must be in the ISO date format YYYY-MM-DDT00:00:00Z. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: Must be end of month. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the MACC which will not change for the lifetime of the MACC. ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall charging when commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
shortfall:
{
Description: MACC shortfall ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
milestones:
{
Description: List of milestones associated with this MACC. ,
Required: False ,
}
[
{
milestoneId:
{
Description: Globally unique identifier for the milestone. Format: {guid} ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment associated with this milestone. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
endAt:
{
Description: End date time for the milestone. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall invoicing when milestone commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Represents the current status of the Milestone. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Completed: No description available. ,
Canceled: No description available. ,
Removed: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
shortfall:
{
Description: Details of the shortfall associated with this milestone. ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resourceId:
{
Description: This is the resource identifier of either the primary MACC or the contributor. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
allowContributors:
{
Description: Setting this to true means multi-entity. ,
Required: False ,
}
boolean ,
primaryResourceId:
{
Description: Fully-qualified resource identifier of the primary MACC. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
primaryBillingAccountResourceId:
{
Description: Fully-qualified billing account resource identifier of the primary MACC. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

POST:  /providers/Microsoft.BillingBenefits/listSellerResources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Request body listing macc by billing account ,
Required: True ,
}
{
properties:
{
Description: Request properties to list maccs under a billing account ,
Required: False ,
}
{
billingAccountResourceId:
{
Description: Fully-qualified billing account resource identifier where the benefit is applied. Present only for Enterprise Agreement customers. ,
Format: arm-id ,
Required: True ,
}
string ,
$filter:
{
Description: This is an OData expresssion to filter the list of MACCs based on the properties of MACC passed in the filter. ,
Required: False ,
}
string ,
contributors:
{
Description: Setting it to true will return the list of contributors associated with the MACC. ,
Required: False ,
}
boolean ,
milestones:
{
Description: Setting it to true will return the list of milestones associated with the MACC. ,
Required: False ,
}
boolean ,
primaryResourceId:
{
Description: Fully-qualified resource identifier of the primary MACC. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: MACC properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of MACC as assigned by RPaaS. This indicates the last operation's status. For all practical purposes, this can be ignored. For current status of MACC resource, refer to MaccStatus. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the MACC. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Stopped: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
entityType:
{
Description: Represents type of the object being operated on. Possible values are primary or contributor. ,
Enum:
{
Primary: No description available. ,
Contributor: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
billingAccountResourceId:
{
Description: Fully-qualified identifier of the billing account where the MACC is applied. Present only for Enterprise Agreement customers. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId} ,
Format: arm-id ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Must be start of month. Timestamp must be in the ISO date format YYYY-MM-DDT00:00:00Z. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: Must be end of month. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the MACC which will not change for the lifetime of the MACC. ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall charging when commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
shortfall:
{
Description: MACC shortfall ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
milestones:
{
Description: List of milestones associated with this MACC. ,
Required: False ,
}
[
{
milestoneId:
{
Description: Globally unique identifier for the milestone. Format: {guid} ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment associated with this milestone. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
endAt:
{
Description: End date time for the milestone. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall invoicing when milestone commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Represents the current status of the Milestone. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Completed: No description available. ,
Canceled: No description available. ,
Removed: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
shortfall:
{
Description: Details of the shortfall associated with this milestone. ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resourceId:
{
Description: This is the resource identifier of either the primary MACC or the contributor. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
allowContributors:
{
Description: Setting this to true means multi-entity. ,
Required: False ,
}
boolean ,
primaryResourceId:
{
Description: Fully-qualified resource identifier of the primary MACC. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
primaryBillingAccountResourceId:
{
Description: Fully-qualified billing account resource identifier of the primary MACC. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ApplicableMaccs_List (new)
Description :  List maccs that are applicable for a given billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.BillingBenefits/applicableMaccs
{
billingAccountId:
{
Description: The billing account Id at which the benefits are listed. Accepted format is: {rootId:orgId}. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List Applicable MACCs. ,
Required: False ,
}
[
{
properties:
{
Description: Applicable MACC properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of MACC as assigned by RPaaS. This indicates the last operation's status. For all practical purposes, this can be ignored. For current status of MACC resource, refer to MaccStatus. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the MACC. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Stopped: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
entityType:
{
Description: Represents type of the object being operated on. Possible values are primary or contributor. ,
Enum:
{
Primary: No description available. ,
Contributor: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
billingAccountResourceId:
{
Description: Fully-qualified identifier of the billing account where the MACC is applied. Present only for Enterprise Agreement customers. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId} ,
Format: arm-id ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Must be start of month. Timestamp must be in the ISO date format YYYY-MM-DDT00:00:00Z. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: Must be end of month. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the MACC which will not change for the lifetime of the MACC. ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall charging when commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
shortfall:
{
Description: MACC shortfall ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
milestones:
{
Description: List of milestones associated with this MACC. ,
Required: False ,
}
[
{
milestoneId:
{
Description: Globally unique identifier for the milestone. Format: {guid} ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment associated with this milestone. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
endAt:
{
Description: End date time for the milestone. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall invoicing when milestone commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Represents the current status of the Milestone. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Completed: No description available. ,
Canceled: No description available. ,
Removed: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
shortfall:
{
Description: Details of the shortfall associated with this milestone. ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resourceId:
{
Description: This is the resource identifier of either the primary MACC or the contributor. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
allowContributors:
{
Description: Setting this to true means multi-entity. ,
Required: False ,
}
boolean ,
primaryResourceId:
{
Description: Fully-qualified resource identifier of the primary MACC. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
primaryBillingAccountResourceId:
{
Description: Fully-qualified billing account resource identifier of the primary MACC. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Url to get the next page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Contributors_ListFromApplicableMacc (new)
Description :  List contributors under applicable MACCs for a given billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.BillingBenefits/applicableMaccs/{systemId}/providers/Microsoft.BillingBenefits/applicableContributors
{
billingAccountId:
{
Description: The billing account Id at which the benefits are listed. Accepted format is: {rootId:orgId}. ,
Required: True ,
}
string ,
systemId:
{
Description: System ID of the primary MACC. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: MACC contributor properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of MACC as assigned by RPaaS. This indicates the last operation's status. For all practical purposes, this can be ignored. For current status of MACC resource, refer to MaccStatus. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the MACC. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Stopped: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
entityType:
{
Description: Represents type of the object being operated on. Possible values are primary or contributor. ,
Enum:
{
Primary: No description available. ,
Contributor: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
billingAccountResourceId:
{
Description: Fully-qualified identifier of the billing account where the MACC is applied. Present only for Enterprise Agreement customers. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId} ,
Format: arm-id ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Must be start of month. Timestamp must be in the ISO date format YYYY-MM-DDT00:00:00Z. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: Must be end of month. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the MACC which will not change for the lifetime of the MACC. ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall charging when commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
shortfall:
{
Description: MACC shortfall ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
milestones:
{
Description: List of milestones associated with this MACC. ,
Required: False ,
}
[
{
milestoneId:
{
Description: Globally unique identifier for the milestone. Format: {guid} ,
Required: False ,
}
string ,
commitment:
{
Description: Commitment associated with this milestone. ,
Required: False ,
}
{
currencyCode:
{
Description: The ISO 4217 3-letter currency code for the currency used by this purchase record. ,
Required: False ,
}
string ,
amount:
{
Format: double ,
Required: False ,
}
number ,
}
,
endAt:
{
Description: End date time for the milestone. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. ,
Format: date-time ,
Required: False ,
}
string ,
automaticShortfall:
{
Description: Setting this to 'Enable' enables automatic shortfall invoicing when milestone commitment is not met. ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
automaticShortfallSuppressReason:
{
Description: Optional field to record suppression reason for automatic shortfall. ,
Required: False ,
}
{
code:
{
Description: Code for the suppression reason. ,
Required: False ,
}
string ,
message:
{
Description: Message for suppression reason. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Represents the current status of the Milestone. ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Completed: No description available. ,
Canceled: No description available. ,
Removed: No description available. ,
PendingSettlement: No description available. ,
ShortfallCharged: No description available. ,
ShortfallWaived: No description available. ,
}
,
Required: False ,
}
enum ,
shortfall:
{
Description: Details of the shortfall associated with this milestone. ,
Required: False ,
}
{
productCode:
{
Description: Represents catalog UPN. ,
Required: False ,
}
string ,
charge:
{
Description: Shortfall amount with grain. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the credits associated with the shortfall. ,
Format: arm-id ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
systemId:
{
Description: This is an identifier of the shortfall which will not change for its lifetime. ,
Required: False ,
}
string ,
}
,
}
,
]
,
resourceId:
{
Description: This is the resource identifier of either the primary MACC or the contributor. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
allowContributors:
{
Description: Setting this to true means multi-entity. ,
Required: False ,
}
boolean ,
primaryResourceId:
{
Description: Fully-qualified resource identifier of the primary MACC. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}. ,
Format: arm-id ,
Required: False ,
}
string ,
primaryBillingAccountResourceId:
{
Description: Fully-qualified billing account resource identifier of the primary MACC. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Url to get the next page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/credits/{creditName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
creditName:
{
Description: Name of the credit ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Credit create request ,
Required: True ,
}
{
properties:
{
Description: Credit properties ,
Required: False ,
}
{
status:
{
Description: Status of the credit ,
Enum:
{
Unknown: Credit status is unknown ,
Pending: Credit is pending activation ,
Active: Credit is active and available for use ,
Succeeded: Credit operation succeeded ,
Canceled: Credit has been cancelled ,
Failed: Credit operation failed ,
Expired: Credit has expired ,
Exhausted: Credit has been fully consumed ,
NotStarted: Credit application has not started yet ,
}
,
Required: False ,
}
enum ,
productCode:
{
Description: Product UPN for the credit type ,
Required: False ,
}
string ,
reason:
{
Description: The reason for the credit. Not required if not applicable. ,
Required: False ,
}
{
code:
{
Description: The reason code for credit. ,
Required: False ,
}
number ,
description:
{
Description: The free string description of the credit. ,
Required: False ,
}
string ,
}
,
credit:
{
Description: The entire investment amount for the credit contract, including currency and amount ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
policies:
{
Description: Credit breakdown item representing a milestone, line-item, or no-charge service ,
Required: False ,
}
{
redemption:
{
Description: Redemption policy of the Credit ,
Enum:
{
NotApplicable: Redemption policy is not applicable for this credit ,
AutoRedeem: Credit is automatically redeemed ,
ManualRedeem: Credit is manually redeemed ,
}
,
Required: False ,
}
enum ,
expiration:
{
Description: Expiration policy of the Credit ,
Enum:
{
None: No policy applied to the expiration of this credit ,
SuspendBillingProfile: Billing profile is suspended when the credit expires ,
}
,
Required: False ,
}
enum ,
}
,
billingAccountResourceId:
{
Description: Fully-qualified identifier of the billing account where the benefit is applied. Present only for Enterprise Agreement customers. ,
Format: arm-id ,
Required: False ,
}
string ,
billingProfileResourceId:
{
Description: Fully-qualified identifier of the billing profile where the benefit is applied. Present only for Field-led or Customer-led customers. ,
Format: arm-id ,
Required: False ,
}
string ,
breakdown:
{
Description: Credit line-items/milestones/no-charge services breakdown ,
Required: False ,
}
[
{
allocation:
{
Description: Allocation details including currency and amount for this breakdown item ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: Key-value pairs for additional parameters and metadata ,
Required: False ,
}
[
{
key:
{
Description: The dimension key (e.g., productFamily, description, creditType) ,
Required: True ,
}
string ,
value:
{
Description: The dimension value ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: System identifier ,
Required: False ,
}
string ,
customerId:
{
Description: Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers. Format is /providers/Microsoft.Billing/billingAccounts/{acctId:orgId} ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the resource. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/{benefitType}/{benefitName}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
}
,
$schema:
{
Description: Credit resource definition ,
}
{
properties:
{
Description: Credit properties ,
Required: False ,
}
{
status:
{
Description: Status of the credit ,
Enum:
{
Unknown: Credit status is unknown ,
Pending: Credit is pending activation ,
Active: Credit is active and available for use ,
Succeeded: Credit operation succeeded ,
Canceled: Credit has been cancelled ,
Failed: Credit operation failed ,
Expired: Credit has expired ,
Exhausted: Credit has been fully consumed ,
NotStarted: Credit application has not started yet ,
}
,
Required: False ,
}
enum ,
productCode:
{
Description: Product UPN for the credit type ,
Required: False ,
}
string ,
reason:
{
Description: The reason for the credit. Not required if not applicable. ,
Required: False ,
}
{
code:
{
Description: The reason code for credit. ,
Required: False ,
}
number ,
description:
{
Description: The free string description of the credit. ,
Required: False ,
}
string ,
}
,
credit:
{
Description: The entire investment amount for the credit contract, including currency and amount ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
policies:
{
Description: Credit breakdown item representing a milestone, line-item, or no-charge service ,
Required: False ,
}
{
redemption:
{
Description: Redemption policy of the Credit ,
Enum:
{
NotApplicable: Redemption policy is not applicable for this credit ,
AutoRedeem: Credit is automatically redeemed ,
ManualRedeem: Credit is manually redeemed ,
}
,
Required: False ,
}
enum ,
expiration:
{
Description: Expiration policy of the Credit ,
Enum:
{
None: No policy applied to the expiration of this credit ,
SuspendBillingProfile: Billing profile is suspended when the credit expires ,
}
,
Required: False ,
}
enum ,
}
,
billingAccountResourceId:
{
Description: Fully-qualified identifier of the billing account where the benefit is applied. Present only for Enterprise Agreement customers. ,
Format: arm-id ,
Required: False ,
}
string ,
billingProfileResourceId:
{
Description: Fully-qualified identifier of the billing profile where the benefit is applied. Present only for Field-led or Customer-led customers. ,
Format: arm-id ,
Required: False ,
}
string ,
breakdown:
{
Description: Credit line-items/milestones/no-charge services breakdown ,
Required: False ,
}
[
{
allocation:
{
Description: Allocation details including currency and amount for this breakdown item ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: Key-value pairs for additional parameters and metadata ,
Required: False ,
}
[
{
key:
{
Description: The dimension key (e.g., productFamily, description, creditType) ,
Required: True ,
}
string ,
value:
{
Description: The dimension value ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: System identifier ,
Required: False ,
}
string ,
customerId:
{
Description: Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers. Format is /providers/Microsoft.Billing/billingAccounts/{acctId:orgId} ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the resource. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/{benefitType}/{benefitName}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: Location URI to poll for result. ,
}
string ,
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}
,
$schema:
{
Description: Credit resource definition ,
}
{
properties:
{
Description: Credit properties ,
Required: False ,
}
{
status:
{
Description: Status of the credit ,
Enum:
{
Unknown: Credit status is unknown ,
Pending: Credit is pending activation ,
Active: Credit is active and available for use ,
Succeeded: Credit operation succeeded ,
Canceled: Credit has been cancelled ,
Failed: Credit operation failed ,
Expired: Credit has expired ,
Exhausted: Credit has been fully consumed ,
NotStarted: Credit application has not started yet ,
}
,
Required: False ,
}
enum ,
productCode:
{
Description: Product UPN for the credit type ,
Required: False ,
}
string ,
reason:
{
Description: The reason for the credit. Not required if not applicable. ,
Required: False ,
}
{
code:
{
Description: The reason code for credit. ,
Required: False ,
}
number ,
description:
{
Description: The free string description of the credit. ,
Required: False ,
}
string ,
}
,
credit:
{
Description: The entire investment amount for the credit contract, including currency and amount ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
policies:
{
Description: Credit breakdown item representing a milestone, line-item, or no-charge service ,
Required: False ,
}
{
redemption:
{
Description: Redemption policy of the Credit ,
Enum:
{
NotApplicable: Redemption policy is not applicable for this credit ,
AutoRedeem: Credit is automatically redeemed ,
ManualRedeem: Credit is manually redeemed ,
}
,
Required: False ,
}
enum ,
expiration:
{
Description: Expiration policy of the Credit ,
Enum:
{
None: No policy applied to the expiration of this credit ,
SuspendBillingProfile: Billing profile is suspended when the credit expires ,
}
,
Required: False ,
}
enum ,
}
,
billingAccountResourceId:
{
Description: Fully-qualified identifier of the billing account where the benefit is applied. Present only for Enterprise Agreement customers. ,
Format: arm-id ,
Required: False ,
}
string ,
billingProfileResourceId:
{
Description: Fully-qualified identifier of the billing profile where the benefit is applied. Present only for Field-led or Customer-led customers. ,
Format: arm-id ,
Required: False ,
}
string ,
breakdown:
{
Description: Credit line-items/milestones/no-charge services breakdown ,
Required: False ,
}
[
{
allocation:
{
Description: Allocation details including currency and amount for this breakdown item ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: Key-value pairs for additional parameters and metadata ,
Required: False ,
}
[
{
key:
{
Description: The dimension key (e.g., productFamily, description, creditType) ,
Required: True ,
}
string ,
value:
{
Description: The dimension value ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: System identifier ,
Required: False ,
}
string ,
customerId:
{
Description: Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers. Format is /providers/Microsoft.Billing/billingAccounts/{acctId:orgId} ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the resource. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/{benefitType}/{benefitName}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
}
,
$schema:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
Credits_Get (new)
Description :  Get a credit.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/credits/{creditName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
creditName:
{
Description: Name of the credit ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Credit properties ,
Required: False ,
}
{
status:
{
Description: Status of the credit ,
Enum:
{
Unknown: Credit status is unknown ,
Pending: Credit is pending activation ,
Active: Credit is active and available for use ,
Succeeded: Credit operation succeeded ,
Canceled: Credit has been cancelled ,
Failed: Credit operation failed ,
Expired: Credit has expired ,
Exhausted: Credit has been fully consumed ,
NotStarted: Credit application has not started yet ,
}
,
Required: False ,
}
enum ,
productCode:
{
Description: Product UPN for the credit type ,
Required: False ,
}
string ,
reason:
{
Description: The reason for the credit. Not required if not applicable. ,
Required: False ,
}
{
code:
{
Description: The reason code for credit. ,
Required: False ,
}
number ,
description:
{
Description: The free string description of the credit. ,
Required: False ,
}
string ,
}
,
credit:
{
Description: The entire investment amount for the credit contract, including currency and amount ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
policies:
{
Description: Credit breakdown item representing a milestone, line-item, or no-charge service ,
Required: False ,
}
{
redemption:
{
Description: Redemption policy of the Credit ,
Enum:
{
NotApplicable: Redemption policy is not applicable for this credit ,
AutoRedeem: Credit is automatically redeemed ,
ManualRedeem: Credit is manually redeemed ,
}
,
Required: False ,
}
enum ,
expiration:
{
Description: Expiration policy of the Credit ,
Enum:
{
None: No policy applied to the expiration of this credit ,
SuspendBillingProfile: Billing profile is suspended when the credit expires ,
}
,
Required: False ,
}
enum ,
}
,
billingAccountResourceId:
{
Description: Fully-qualified identifier of the billing account where the benefit is applied. Present only for Enterprise Agreement customers. ,
Format: arm-id ,
Required: False ,
}
string ,
billingProfileResourceId:
{
Description: Fully-qualified identifier of the billing profile where the benefit is applied. Present only for Field-led or Customer-led customers. ,
Format: arm-id ,
Required: False ,
}
string ,
breakdown:
{
Description: Credit line-items/milestones/no-charge services breakdown ,
Required: False ,
}
[
{
allocation:
{
Description: Allocation details including currency and amount for this breakdown item ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: Key-value pairs for additional parameters and metadata ,
Required: False ,
}
[
{
key:
{
Description: The dimension key (e.g., productFamily, description, creditType) ,
Required: True ,
}
string ,
value:
{
Description: The dimension value ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: System identifier ,
Required: False ,
}
string ,
customerId:
{
Description: Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers. Format is /providers/Microsoft.Billing/billingAccounts/{acctId:orgId} ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the resource. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/{benefitType}/{benefitName}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/credits/{creditName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
creditName:
{
Description: Name of the credit ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Credit patch request ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Credit patch properties ,
Required: False ,
}
{
credit:
{
Description: The entire investment amount for the credit contract, including currency and amount. Only amount can be modified. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
breakdown:
{
Description: Credit line-items/milestones/no-charge services breakdown. Entire breakdown will be replaced in a PATCH operation. ,
Required: False ,
}
[
{
allocation:
{
Description: Allocation details including currency and amount for this breakdown item ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: Key-value pairs for additional parameters and metadata ,
Required: False ,
}
[
{
key:
{
Description: The dimension key (e.g., productFamily, description, creditType) ,
Required: True ,
}
string ,
value:
{
Description: The dimension value ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
}
,
$schema:
{
Description: Credit resource definition ,
}
{
properties:
{
Description: Credit properties ,
Required: False ,
}
{
status:
{
Description: Status of the credit ,
Enum:
{
Unknown: Credit status is unknown ,
Pending: Credit is pending activation ,
Active: Credit is active and available for use ,
Succeeded: Credit operation succeeded ,
Canceled: Credit has been cancelled ,
Failed: Credit operation failed ,
Expired: Credit has expired ,
Exhausted: Credit has been fully consumed ,
NotStarted: Credit application has not started yet ,
}
,
Required: False ,
}
enum ,
productCode:
{
Description: Product UPN for the credit type ,
Required: False ,
}
string ,
reason:
{
Description: The reason for the credit. Not required if not applicable. ,
Required: False ,
}
{
code:
{
Description: The reason code for credit. ,
Required: False ,
}
number ,
description:
{
Description: The free string description of the credit. ,
Required: False ,
}
string ,
}
,
credit:
{
Description: The entire investment amount for the credit contract, including currency and amount ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
policies:
{
Description: Credit breakdown item representing a milestone, line-item, or no-charge service ,
Required: False ,
}
{
redemption:
{
Description: Redemption policy of the Credit ,
Enum:
{
NotApplicable: Redemption policy is not applicable for this credit ,
AutoRedeem: Credit is automatically redeemed ,
ManualRedeem: Credit is manually redeemed ,
}
,
Required: False ,
}
enum ,
expiration:
{
Description: Expiration policy of the Credit ,
Enum:
{
None: No policy applied to the expiration of this credit ,
SuspendBillingProfile: Billing profile is suspended when the credit expires ,
}
,
Required: False ,
}
enum ,
}
,
billingAccountResourceId:
{
Description: Fully-qualified identifier of the billing account where the benefit is applied. Present only for Enterprise Agreement customers. ,
Format: arm-id ,
Required: False ,
}
string ,
billingProfileResourceId:
{
Description: Fully-qualified identifier of the billing profile where the benefit is applied. Present only for Field-led or Customer-led customers. ,
Format: arm-id ,
Required: False ,
}
string ,
breakdown:
{
Description: Credit line-items/milestones/no-charge services breakdown ,
Required: False ,
}
[
{
allocation:
{
Description: Allocation details including currency and amount for this breakdown item ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: Key-value pairs for additional parameters and metadata ,
Required: False ,
}
[
{
key:
{
Description: The dimension key (e.g., productFamily, description, creditType) ,
Required: True ,
}
string ,
value:
{
Description: The dimension value ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: System identifier ,
Required: False ,
}
string ,
customerId:
{
Description: Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers. Format is /providers/Microsoft.Billing/billingAccounts/{acctId:orgId} ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the resource. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/{benefitType}/{benefitName}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
location:
{
Description: Location URI to poll for result. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
}
,
$schema:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
Credits_Delete (new)
Description :  Delete a credit.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/credits/{creditName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
creditName:
{
Description: Name of the credit ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result. ,
}
string ,
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}

⚐ Response (204)

{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
}
,
$schema:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
Credits_ListByResourceGroup (new)
Description :  List Credits under a resource group from primary service admin.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/credits
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of credits ,
Required: False ,
}
[
{
properties:
{
Description: Credit properties ,
Required: False ,
}
{
status:
{
Description: Status of the credit ,
Enum:
{
Unknown: Credit status is unknown ,
Pending: Credit is pending activation ,
Active: Credit is active and available for use ,
Succeeded: Credit operation succeeded ,
Canceled: Credit has been cancelled ,
Failed: Credit operation failed ,
Expired: Credit has expired ,
Exhausted: Credit has been fully consumed ,
NotStarted: Credit application has not started yet ,
}
,
Required: False ,
}
enum ,
productCode:
{
Description: Product UPN for the credit type ,
Required: False ,
}
string ,
reason:
{
Description: The reason for the credit. Not required if not applicable. ,
Required: False ,
}
{
code:
{
Description: The reason code for credit. ,
Required: False ,
}
number ,
description:
{
Description: The free string description of the credit. ,
Required: False ,
}
string ,
}
,
credit:
{
Description: The entire investment amount for the credit contract, including currency and amount ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
policies:
{
Description: Credit breakdown item representing a milestone, line-item, or no-charge service ,
Required: False ,
}
{
redemption:
{
Description: Redemption policy of the Credit ,
Enum:
{
NotApplicable: Redemption policy is not applicable for this credit ,
AutoRedeem: Credit is automatically redeemed ,
ManualRedeem: Credit is manually redeemed ,
}
,
Required: False ,
}
enum ,
expiration:
{
Description: Expiration policy of the Credit ,
Enum:
{
None: No policy applied to the expiration of this credit ,
SuspendBillingProfile: Billing profile is suspended when the credit expires ,
}
,
Required: False ,
}
enum ,
}
,
billingAccountResourceId:
{
Description: Fully-qualified identifier of the billing account where the benefit is applied. Present only for Enterprise Agreement customers. ,
Format: arm-id ,
Required: False ,
}
string ,
billingProfileResourceId:
{
Description: Fully-qualified identifier of the billing profile where the benefit is applied. Present only for Field-led or Customer-led customers. ,
Format: arm-id ,
Required: False ,
}
string ,
breakdown:
{
Description: Credit line-items/milestones/no-charge services breakdown ,
Required: False ,
}
[
{
allocation:
{
Description: Allocation details including currency and amount for this breakdown item ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: Key-value pairs for additional parameters and metadata ,
Required: False ,
}
[
{
key:
{
Description: The dimension key (e.g., productFamily, description, creditType) ,
Required: True ,
}
string ,
value:
{
Description: The dimension value ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: System identifier ,
Required: False ,
}
string ,
customerId:
{
Description: Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers. Format is /providers/Microsoft.Billing/billingAccounts/{acctId:orgId} ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the resource. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/{benefitType}/{benefitName}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Credits_ListBySubscription (new)
Description :  List credits under a subscription from primary service tenant.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.BillingBenefits/credits
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of credits ,
Required: False ,
}
[
{
properties:
{
Description: Credit properties ,
Required: False ,
}
{
status:
{
Description: Status of the credit ,
Enum:
{
Unknown: Credit status is unknown ,
Pending: Credit is pending activation ,
Active: Credit is active and available for use ,
Succeeded: Credit operation succeeded ,
Canceled: Credit has been cancelled ,
Failed: Credit operation failed ,
Expired: Credit has expired ,
Exhausted: Credit has been fully consumed ,
NotStarted: Credit application has not started yet ,
}
,
Required: False ,
}
enum ,
productCode:
{
Description: Product UPN for the credit type ,
Required: False ,
}
string ,
reason:
{
Description: The reason for the credit. Not required if not applicable. ,
Required: False ,
}
{
code:
{
Description: The reason code for credit. ,
Required: False ,
}
number ,
description:
{
Description: The free string description of the credit. ,
Required: False ,
}
string ,
}
,
credit:
{
Description: The entire investment amount for the credit contract, including currency and amount ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
policies:
{
Description: Credit breakdown item representing a milestone, line-item, or no-charge service ,
Required: False ,
}
{
redemption:
{
Description: Redemption policy of the Credit ,
Enum:
{
NotApplicable: Redemption policy is not applicable for this credit ,
AutoRedeem: Credit is automatically redeemed ,
ManualRedeem: Credit is manually redeemed ,
}
,
Required: False ,
}
enum ,
expiration:
{
Description: Expiration policy of the Credit ,
Enum:
{
None: No policy applied to the expiration of this credit ,
SuspendBillingProfile: Billing profile is suspended when the credit expires ,
}
,
Required: False ,
}
enum ,
}
,
billingAccountResourceId:
{
Description: Fully-qualified identifier of the billing account where the benefit is applied. Present only for Enterprise Agreement customers. ,
Format: arm-id ,
Required: False ,
}
string ,
billingProfileResourceId:
{
Description: Fully-qualified identifier of the billing profile where the benefit is applied. Present only for Field-led or Customer-led customers. ,
Format: arm-id ,
Required: False ,
}
string ,
breakdown:
{
Description: Credit line-items/milestones/no-charge services breakdown ,
Required: False ,
}
[
{
allocation:
{
Description: Allocation details including currency and amount for this breakdown item ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: Key-value pairs for additional parameters and metadata ,
Required: False ,
}
[
{
key:
{
Description: The dimension key (e.g., productFamily, description, creditType) ,
Required: True ,
}
string ,
value:
{
Description: The dimension value ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: System identifier ,
Required: False ,
}
string ,
customerId:
{
Description: Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers. Format is /providers/Microsoft.Billing/billingAccounts/{acctId:orgId} ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the resource. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/{benefitType}/{benefitName}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/credits/{creditName}/cancel
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
creditName:
{
Description: Name of the credit ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result. ,
}
string ,
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}

⚐ Response (200)

{
$headers:
{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
}
,
$schema:
{
Description: Credit resource definition ,
}
{
properties:
{
Description: Credit properties ,
Required: False ,
}
{
status:
{
Description: Status of the credit ,
Enum:
{
Unknown: Credit status is unknown ,
Pending: Credit is pending activation ,
Active: Credit is active and available for use ,
Succeeded: Credit operation succeeded ,
Canceled: Credit has been cancelled ,
Failed: Credit operation failed ,
Expired: Credit has expired ,
Exhausted: Credit has been fully consumed ,
NotStarted: Credit application has not started yet ,
}
,
Required: False ,
}
enum ,
productCode:
{
Description: Product UPN for the credit type ,
Required: False ,
}
string ,
reason:
{
Description: The reason for the credit. Not required if not applicable. ,
Required: False ,
}
{
code:
{
Description: The reason code for credit. ,
Required: False ,
}
number ,
description:
{
Description: The free string description of the credit. ,
Required: False ,
}
string ,
}
,
credit:
{
Description: The entire investment amount for the credit contract, including currency and amount ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
policies:
{
Description: Credit breakdown item representing a milestone, line-item, or no-charge service ,
Required: False ,
}
{
redemption:
{
Description: Redemption policy of the Credit ,
Enum:
{
NotApplicable: Redemption policy is not applicable for this credit ,
AutoRedeem: Credit is automatically redeemed ,
ManualRedeem: Credit is manually redeemed ,
}
,
Required: False ,
}
enum ,
expiration:
{
Description: Expiration policy of the Credit ,
Enum:
{
None: No policy applied to the expiration of this credit ,
SuspendBillingProfile: Billing profile is suspended when the credit expires ,
}
,
Required: False ,
}
enum ,
}
,
billingAccountResourceId:
{
Description: Fully-qualified identifier of the billing account where the benefit is applied. Present only for Enterprise Agreement customers. ,
Format: arm-id ,
Required: False ,
}
string ,
billingProfileResourceId:
{
Description: Fully-qualified identifier of the billing profile where the benefit is applied. Present only for Field-led or Customer-led customers. ,
Format: arm-id ,
Required: False ,
}
string ,
breakdown:
{
Description: Credit line-items/milestones/no-charge services breakdown ,
Required: False ,
}
[
{
allocation:
{
Description: Allocation details including currency and amount for this breakdown item ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: Key-value pairs for additional parameters and metadata ,
Required: False ,
}
[
{
key:
{
Description: The dimension key (e.g., productFamily, description, creditType) ,
Required: True ,
}
string ,
value:
{
Description: The dimension value ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: System identifier ,
Required: False ,
}
string ,
customerId:
{
Description: Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers. Format is /providers/Microsoft.Billing/billingAccounts/{acctId:orgId} ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the resource. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/{benefitType}/{benefitName}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
}
,
$schema:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
Sources_Create (new)
Description :  Create a credit source.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/credits/{creditName}/sources/{sourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
creditName:
{
Description: Name of the credit ,
Required: True ,
}
string ,
sourceName:
{
Description: Name of the credit source ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Credit source create request ,
Required: True ,
}
{
properties:
{
Description: Credit source properties ,
Required: False ,
}
{
status:
{
Description: Status of the credit ,
Enum:
{
Unknown: Credit status is unknown ,
Pending: Credit is pending activation ,
Active: Credit is active and available for use ,
Succeeded: Credit operation succeeded ,
Canceled: Credit has been cancelled ,
Failed: Credit operation failed ,
Expired: Credit has expired ,
Exhausted: Credit has been fully consumed ,
NotStarted: Credit application has not started yet ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: The uri of the resource impacted which lead to the grant of the credit. ,
Format: arm-id ,
Required: False ,
}
string ,
impactedBillingPeriod:
{
Description: The billing period of the impact for the resource. Format YYYYMM ,
Required: False ,
}
string ,
credit:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Credit source properties ,
Required: False ,
}
{
status:
{
Description: Status of the credit ,
Enum:
{
Unknown: Credit status is unknown ,
Pending: Credit is pending activation ,
Active: Credit is active and available for use ,
Succeeded: Credit operation succeeded ,
Canceled: Credit has been cancelled ,
Failed: Credit operation failed ,
Expired: Credit has expired ,
Exhausted: Credit has been fully consumed ,
NotStarted: Credit application has not started yet ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: The uri of the resource impacted which lead to the grant of the credit. ,
Format: arm-id ,
Required: False ,
}
string ,
impactedBillingPeriod:
{
Description: The billing period of the impact for the resource. Format YYYYMM ,
Required: False ,
}
string ,
credit:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Credit source properties ,
Required: False ,
}
{
status:
{
Description: Status of the credit ,
Enum:
{
Unknown: Credit status is unknown ,
Pending: Credit is pending activation ,
Active: Credit is active and available for use ,
Succeeded: Credit operation succeeded ,
Canceled: Credit has been cancelled ,
Failed: Credit operation failed ,
Expired: Credit has expired ,
Exhausted: Credit has been fully consumed ,
NotStarted: Credit application has not started yet ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: The uri of the resource impacted which lead to the grant of the credit. ,
Format: arm-id ,
Required: False ,
}
string ,
impactedBillingPeriod:
{
Description: The billing period of the impact for the resource. Format YYYYMM ,
Required: False ,
}
string ,
credit:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Sources_Get (new)
Description :  Get a credit source.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/credits/{creditName}/sources/{sourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
creditName:
{
Description: Name of the credit ,
Required: True ,
}
string ,
sourceName:
{
Description: Name of the credit source ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Credit source properties ,
Required: False ,
}
{
status:
{
Description: Status of the credit ,
Enum:
{
Unknown: Credit status is unknown ,
Pending: Credit is pending activation ,
Active: Credit is active and available for use ,
Succeeded: Credit operation succeeded ,
Canceled: Credit has been cancelled ,
Failed: Credit operation failed ,
Expired: Credit has expired ,
Exhausted: Credit has been fully consumed ,
NotStarted: Credit application has not started yet ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: The uri of the resource impacted which lead to the grant of the credit. ,
Format: arm-id ,
Required: False ,
}
string ,
impactedBillingPeriod:
{
Description: The billing period of the impact for the resource. Format YYYYMM ,
Required: False ,
}
string ,
credit:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Sources_Update (new)
Description :  Update a credit source.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/credits/{creditName}/sources/{sourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
creditName:
{
Description: Name of the credit ,
Required: True ,
}
string ,
sourceName:
{
Description: Name of the credit source ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Credit source patch request ,
Required: True ,
}
{
tags:
{
Description: Resource Tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Credit source properties ,
Required: False ,
}
{
status:
{
Description: Status of the credit ,
Enum:
{
Unknown: Credit status is unknown ,
Pending: Credit is pending activation ,
Active: Credit is active and available for use ,
Succeeded: Credit operation succeeded ,
Canceled: Credit has been cancelled ,
Failed: Credit operation failed ,
Expired: Credit has expired ,
Exhausted: Credit has been fully consumed ,
NotStarted: Credit application has not started yet ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: The uri of the resource impacted which lead to the grant of the credit. ,
Format: arm-id ,
Required: False ,
}
string ,
impactedBillingPeriod:
{
Description: The billing period of the impact for the resource. Format YYYYMM ,
Required: False ,
}
string ,
credit:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Sources_Delete (new)
Description :  Delete a credit source.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/credits/{creditName}/sources/{sourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
creditName:
{
Description: Name of the credit ,
Required: True ,
}
string ,
sourceName:
{
Description: Name of the credit source ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Sources_ListByCredit (new)
Description :  List credit sources for a credit under a resource group from primary service admin.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/credits/{creditName}/sources
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
creditName:
{
Description: Name of the credit ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of credit sources ,
Required: False ,
}
[
{
properties:
{
Description: Credit source properties ,
Required: False ,
}
{
status:
{
Description: Status of the credit ,
Enum:
{
Unknown: Credit status is unknown ,
Pending: Credit is pending activation ,
Active: Credit is active and available for use ,
Succeeded: Credit operation succeeded ,
Canceled: Credit has been cancelled ,
Failed: Credit operation failed ,
Expired: Credit has expired ,
Exhausted: Credit has been fully consumed ,
NotStarted: Credit application has not started yet ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: The uri of the resource impacted which lead to the grant of the credit. ,
Format: arm-id ,
Required: False ,
}
string ,
impactedBillingPeriod:
{
Description: The billing period of the impact for the resource. Format YYYYMM ,
Required: False ,
}
string ,
credit:
{
Description: Commitment towards the benefit. ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Credits_ListApplicable (new)
Description :  List applicable credits for the provided scope. Currently supported scopes: BillingAccountResourceId
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.BillingBenefits/applicableCredits
{
scope:
{
Description: The scope at which the benefits are listed. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of credits ,
Required: False ,
}
[
{
properties:
{
Description: Credit properties ,
Required: False ,
}
{
status:
{
Description: Status of the credit ,
Enum:
{
Unknown: Credit status is unknown ,
Pending: Credit is pending activation ,
Active: Credit is active and available for use ,
Succeeded: Credit operation succeeded ,
Canceled: Credit has been cancelled ,
Failed: Credit operation failed ,
Expired: Credit has expired ,
Exhausted: Credit has been fully consumed ,
NotStarted: Credit application has not started yet ,
}
,
Required: False ,
}
enum ,
productCode:
{
Description: Product UPN for the credit type ,
Required: False ,
}
string ,
reason:
{
Description: The reason for the credit. Not required if not applicable. ,
Required: False ,
}
{
code:
{
Description: The reason code for credit. ,
Required: False ,
}
number ,
description:
{
Description: The free string description of the credit. ,
Required: False ,
}
string ,
}
,
credit:
{
Description: The entire investment amount for the credit contract, including currency and amount ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
policies:
{
Description: Credit breakdown item representing a milestone, line-item, or no-charge service ,
Required: False ,
}
{
redemption:
{
Description: Redemption policy of the Credit ,
Enum:
{
NotApplicable: Redemption policy is not applicable for this credit ,
AutoRedeem: Credit is automatically redeemed ,
ManualRedeem: Credit is manually redeemed ,
}
,
Required: False ,
}
enum ,
expiration:
{
Description: Expiration policy of the Credit ,
Enum:
{
None: No policy applied to the expiration of this credit ,
SuspendBillingProfile: Billing profile is suspended when the credit expires ,
}
,
Required: False ,
}
enum ,
}
,
billingAccountResourceId:
{
Description: Fully-qualified identifier of the billing account where the benefit is applied. Present only for Enterprise Agreement customers. ,
Format: arm-id ,
Required: False ,
}
string ,
billingProfileResourceId:
{
Description: Fully-qualified identifier of the billing profile where the benefit is applied. Present only for Field-led or Customer-led customers. ,
Format: arm-id ,
Required: False ,
}
string ,
breakdown:
{
Description: Credit line-items/milestones/no-charge services breakdown ,
Required: False ,
}
[
{
allocation:
{
Description: Allocation details including currency and amount for this breakdown item ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start DateTime. ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
dimensions:
{
Description: Key-value pairs for additional parameters and metadata ,
Required: False ,
}
[
{
key:
{
Description: The dimension key (e.g., productFamily, description, creditType) ,
Required: True ,
}
string ,
value:
{
Description: The dimension value ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: Provisioning state ,
Enum:
{
Creating: No description available. ,
PendingBilling: No description available. ,
ConfirmedBilling: No description available. ,
Created: No description available. ,
Succeeded: No description available. ,
Cancelled: No description available. ,
Expired: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: System identifier ,
Required: False ,
}
string ,
customerId:
{
Description: Fully-qualified identifier of the customer where the savings plan is applied. Present only for Partner-led customers. Format is /providers/Microsoft.Billing/billingAccounts/{acctId:orgId} ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the resource. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/{benefitType}/{benefitName}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/conditionalCredits/{conditionalCreditName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
conditionalCreditName:
{
Description: Name of the conditional credit ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Request body for creating a conditional credit ,
Required: True ,
}
{
properties:
{
Description: Conditional credit properties ,
Required: False ,
}
{
entityType:
{
Description: Type of conditional credit entity ,
Enum:
{
Primary: No description available. ,
Contributor: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name for the conditional credit ,
Required: False ,
}
string ,
billingAccountResourceId:
{
Description: The billing account resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the conditional credit ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Stopped: No description available. ,
PendingSettlement: No description available. ,
}
,
Required: False ,
}
enum ,
startAt:
{
Description: Start date of the conditional credit ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End date of the conditional credit (derived from last milestone) ,
Format: date-time ,
Required: False ,
}
string ,
productCode:
{
Description: Product code for the conditional credit ,
Required: False ,
}
string ,
benefitResourceId:
{
Description: Fully-qualified identifier of the benefit under applicable benefit list. ,
Format: arm-id ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the resource. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/{benefitType}/{benefitName}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
}
,
$schema:
{
Description: Resource definition for Conditional Credits. ,
}
{
properties:
{
Description: Conditional credit properties ,
Required: False ,
}
{
entityType:
{
Description: Type of conditional credit entity ,
Enum:
{
Primary: No description available. ,
Contributor: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name for the conditional credit ,
Required: False ,
}
string ,
billingAccountResourceId:
{
Description: The billing account resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the conditional credit ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Stopped: No description available. ,
PendingSettlement: No description available. ,
}
,
Required: False ,
}
enum ,
startAt:
{
Description: Start date of the conditional credit ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End date of the conditional credit (derived from last milestone) ,
Format: date-time ,
Required: False ,
}
string ,
productCode:
{
Description: Product code for the conditional credit ,
Required: False ,
}
string ,
benefitResourceId:
{
Description: Fully-qualified identifier of the benefit under applicable benefit list. ,
Format: arm-id ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the resource. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/{benefitType}/{benefitName}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}
,
$schema:
{
Description: Resource definition for Conditional Credits. ,
}
{
properties:
{
Description: Conditional credit properties ,
Required: False ,
}
{
entityType:
{
Description: Type of conditional credit entity ,
Enum:
{
Primary: No description available. ,
Contributor: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name for the conditional credit ,
Required: False ,
}
string ,
billingAccountResourceId:
{
Description: The billing account resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the conditional credit ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Stopped: No description available. ,
PendingSettlement: No description available. ,
}
,
Required: False ,
}
enum ,
startAt:
{
Description: Start date of the conditional credit ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End date of the conditional credit (derived from last milestone) ,
Format: date-time ,
Required: False ,
}
string ,
productCode:
{
Description: Product code for the conditional credit ,
Required: False ,
}
string ,
benefitResourceId:
{
Description: Fully-qualified identifier of the benefit under applicable benefit list. ,
Format: arm-id ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the resource. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/{benefitType}/{benefitName}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
}
,
$schema:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
ConditionalCredits_Get (new)
Description :  Get a conditional credit.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/conditionalCredits/{conditionalCreditName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
conditionalCreditName:
{
Description: Name of the conditional credit ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Conditional credit properties ,
Required: False ,
}
{
entityType:
{
Description: Type of conditional credit entity ,
Enum:
{
Primary: No description available. ,
Contributor: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name for the conditional credit ,
Required: False ,
}
string ,
billingAccountResourceId:
{
Description: The billing account resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the conditional credit ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Stopped: No description available. ,
PendingSettlement: No description available. ,
}
,
Required: False ,
}
enum ,
startAt:
{
Description: Start date of the conditional credit ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End date of the conditional credit (derived from last milestone) ,
Format: date-time ,
Required: False ,
}
string ,
productCode:
{
Description: Product code for the conditional credit ,
Required: False ,
}
string ,
benefitResourceId:
{
Description: Fully-qualified identifier of the benefit under applicable benefit list. ,
Format: arm-id ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the resource. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/{benefitType}/{benefitName}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConditionalCredits_Update (new)
Description :  Update a conditional credit.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/conditionalCredits/{conditionalCreditName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
conditionalCreditName:
{
Description: Name of the conditional credit ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Request body for updating a conditional credit ,
Required: True ,
}
{
properties:
{
Description: Conditional credit patch request properties ,
Required: False ,
}
{
displayName:
{
Description: Display name for the conditional credit ,
Required: False ,
}
string ,
endAt:
{
Description: End DateTime in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
allowContributors:
{
Description: Whether this conditional credit allows contributor billing accounts ,
Enum:
{
Unknown: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
milestones:
{
Description: Updated milestones list (only applicable for primary conditional credits) ,
Required: False ,
}
[
{
award:
{
Description: Award details for this milestone ,
Required: False ,
}
{
credit:
{
Description: Credit amount to be awarded ,
Required: False ,
}
{
grain:
{
Description: The grain of the commitment. ,
Enum:
{
Unknown: No description available. ,
Hourly: No description available. ,
FullTerm: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
startAt:
{
Description: Start date when the credit becomes effective ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End date when the credit expires ,
Format: date-time ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource ID for the awarded credit. ,
Format: arm-id ,
Required: False ,
}
string ,
systemId:
{
Description: This is the globally unique identifier of the credit which will not change for its lifetime. ,
Required: False ,
}
string ,
balanceVersion:
{
Description: Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. ,
Required: False ,
}
number ,
duration:
{
Description: Duration for which the benefit is active. Will be in format P{int}M or P{int}Y. Any values representing up to 12 years are valid. Upper limit examples: P144M, P12Y. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
$headers:
{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
}
,
$schema:
{
Description: Resource definition for Conditional Credits. ,
}
{
properties:
{
Description: Conditional credit properties ,
Required: False ,
}
{
entityType:
{
Description: Type of conditional credit entity ,
Enum:
{
Primary: No description available. ,
Contributor: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name for the conditional credit ,
Required: False ,
}
string ,
billingAccountResourceId:
{
Description: The billing account resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the conditional credit ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Stopped: No description available. ,
PendingSettlement: No description available. ,
}
,
Required: False ,
}
enum ,
startAt:
{
Description: Start date of the conditional credit ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End date of the conditional credit (derived from last milestone) ,
Format: date-time ,
Required: False ,
}
string ,
productCode:
{
Description: Product code for the conditional credit ,
Required: False ,
}
string ,
benefitResourceId:
{
Description: Fully-qualified identifier of the benefit under applicable benefit list. ,
Format: arm-id ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the resource. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/{benefitType}/{benefitName}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
location:
{
Description: Location URI to poll for result. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
}
,
$schema:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
ConditionalCredits_Delete (new)
Description :  Delete a conditional credit.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/conditionalCredits/{conditionalCreditName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
conditionalCreditName:
{
Description: Name of the conditional credit ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result. ,
}
string ,
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}

⚐ Response (204)

{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
}
,
$schema:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
ConditionalCredits_ListByResourceGroup (new)
Description :  List conditional credits by resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/conditionalCredits
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of applicable conditional credits ,
Required: False ,
}
[
{
properties:
{
Description: Conditional credit properties ,
Required: False ,
}
{
entityType:
{
Description: Type of conditional credit entity ,
Enum:
{
Primary: No description available. ,
Contributor: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name for the conditional credit ,
Required: False ,
}
string ,
billingAccountResourceId:
{
Description: The billing account resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the conditional credit ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Stopped: No description available. ,
PendingSettlement: No description available. ,
}
,
Required: False ,
}
enum ,
startAt:
{
Description: Start date of the conditional credit ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End date of the conditional credit (derived from last milestone) ,
Format: date-time ,
Required: False ,
}
string ,
productCode:
{
Description: Product code for the conditional credit ,
Required: False ,
}
string ,
benefitResourceId:
{
Description: Fully-qualified identifier of the benefit under applicable benefit list. ,
Format: arm-id ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the resource. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/{benefitType}/{benefitName}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConditionalCredits_ListBySubscription (new)
Description :  List conditional credits by subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.BillingBenefits/conditionalCredits
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of applicable conditional credits ,
Required: False ,
}
[
{
properties:
{
Description: Conditional credit properties ,
Required: False ,
}
{
entityType:
{
Description: Type of conditional credit entity ,
Enum:
{
Primary: No description available. ,
Contributor: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name for the conditional credit ,
Required: False ,
}
string ,
billingAccountResourceId:
{
Description: The billing account resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the conditional credit ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Stopped: No description available. ,
PendingSettlement: No description available. ,
}
,
Required: False ,
}
enum ,
startAt:
{
Description: Start date of the conditional credit ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End date of the conditional credit (derived from last milestone) ,
Format: date-time ,
Required: False ,
}
string ,
productCode:
{
Description: Product code for the conditional credit ,
Required: False ,
}
string ,
benefitResourceId:
{
Description: Fully-qualified identifier of the benefit under applicable benefit list. ,
Format: arm-id ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the resource. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/{benefitType}/{benefitName}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConditionalCredits_Cancel (new)
Description :  Cancel conditional credit. Stops applying the benefit.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/conditionalCredits/{conditionalCreditName}/cancel
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
conditionalCreditName:
{
Description: Name of the conditional credit ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result. ,
}
string ,
azure-asyncoperation:
{
Description: URL for checking the ongoing status of the operation. ,
}
string ,
retry-after:
{
Description: Clients should wait for the Retry-After interval before polling again ,
}
integer ,
}

⚐ Response (200)

{
properties:
{
Description: Conditional credit properties ,
Required: False ,
}
{
entityType:
{
Description: Type of conditional credit entity ,
Enum:
{
Primary: No description available. ,
Contributor: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name for the conditional credit ,
Required: False ,
}
string ,
billingAccountResourceId:
{
Description: The billing account resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the conditional credit ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Stopped: No description available. ,
PendingSettlement: No description available. ,
}
,
Required: False ,
}
enum ,
startAt:
{
Description: Start date of the conditional credit ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End date of the conditional credit (derived from last milestone) ,
Format: date-time ,
Required: False ,
}
string ,
productCode:
{
Description: Product code for the conditional credit ,
Required: False ,
}
string ,
benefitResourceId:
{
Description: Fully-qualified identifier of the benefit under applicable benefit list. ,
Format: arm-id ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the resource. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/{benefitType}/{benefitName}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConditionalCreditContributors_GetFromPrimary (new)
Description :  Get a conditional credit contributor for primary service admin
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/conditionalCredits/{conditionalCreditName}/contributors/{contributorName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
conditionalCreditName:
{
Description: Name of the conditional credit ,
Required: True ,
}
string ,
contributorName:
{
Description: Unique name of contributor in the format {contributorCloudSubId}_{resourceGroupName}_{nameInContributorTenant}. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Conditional credit contributor properties ,
Required: False ,
}
{
primaryResourceId:
{
Description: Resource ID of the primary conditional credit (required for contributors) ,
Format: arm-id ,
Required: False ,
}
string ,
systemId:
{
Description: System identifier shared between primary and contributor conditional credits representing the same conditional credit program ,
Required: False ,
}
string ,
productCode:
{
Description: Product code for the contributor conditional credit ,
Required: False ,
}
string ,
startAt:
{
Description: Start date when the contributor begins contributing ,
Format: date-time ,
Required: False ,
}
string ,
milestones:
{
Description: List of milestones copied from primary conditional credit (excludes award details) ,
Required: False ,
}
[
object ,
]
,
primaryBillingAccountResourceId:
{
Description: Fully-qualified billing account resource identifier of the primary CACO. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConditionalCreditContributors_ListFromPrimary (new)
Description :  List contributors under a primary conditional credit for primary service admin
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/conditionalCredits/{conditionalCreditName}/contributors
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
conditionalCreditName:
{
Description: Name of the conditional credit ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: Conditional credit contributor properties ,
Required: False ,
}
{
primaryResourceId:
{
Description: Resource ID of the primary conditional credit (required for contributors) ,
Format: arm-id ,
Required: False ,
}
string ,
systemId:
{
Description: System identifier shared between primary and contributor conditional credits representing the same conditional credit program ,
Required: False ,
}
string ,
productCode:
{
Description: Product code for the contributor conditional credit ,
Required: False ,
}
string ,
startAt:
{
Description: Start date when the contributor begins contributing ,
Format: date-time ,
Required: False ,
}
string ,
milestones:
{
Description: List of milestones copied from primary conditional credit (excludes award details) ,
Required: False ,
}
[
object ,
]
,
primaryBillingAccountResourceId:
{
Description: Fully-qualified billing account resource identifier of the primary CACO. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Url to get the next page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConditionalCredits_ScopeList (new)
Description :  List conditional credits that are applicable for a given scope. Currently supported scopes: billing accounts
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.BillingBenefits/applicableConditionalCredits
{
scope:
{
Description: The scope at which the benefits are listed. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of applicable conditional credits ,
Required: False ,
}
[
{
properties:
{
Description: Conditional credit properties ,
Required: False ,
}
{
entityType:
{
Description: Type of conditional credit entity ,
Enum:
{
Primary: No description available. ,
Contributor: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name for the conditional credit ,
Required: False ,
}
string ,
billingAccountResourceId:
{
Description: The billing account resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the conditional credit ,
Enum:
{
Unknown: No description available. ,
Scheduled: No description available. ,
Active: No description available. ,
Pending: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Completed: No description available. ,
Stopped: No description available. ,
PendingSettlement: No description available. ,
}
,
Required: False ,
}
enum ,
startAt:
{
Description: Start date of the conditional credit ,
Format: date-time ,
Required: False ,
}
string ,
endAt:
{
Description: End date of the conditional credit (derived from last milestone) ,
Format: date-time ,
Required: False ,
}
string ,
productCode:
{
Description: Product code for the conditional credit ,
Required: False ,
}
string ,
benefitResourceId:
{
Description: Fully-qualified identifier of the benefit under applicable benefit list. ,
Format: arm-id ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully-qualified resource identifier of the resource. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/{benefitType}/{benefitName}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConditionalCreditContributors_ListFromApplicableConditionalCredit (new)
Description :  List contributors under applicable conditional credits for a given billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.BillingBenefits/applicableConditionalCredits/{systemId}/providers/Microsoft.BillingBenefits/applicableContributors
{
billingAccountId:
{
Description: The billing account Id at which the benefits are listed. Accepted format is: {rootId:orgId}. ,
Required: True ,
}
string ,
systemId:
{
Description: System ID of the primary MACC. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: Conditional credit contributor properties ,
Required: False ,
}
{
primaryResourceId:
{
Description: Resource ID of the primary conditional credit (required for contributors) ,
Format: arm-id ,
Required: False ,
}
string ,
systemId:
{
Description: System identifier shared between primary and contributor conditional credits representing the same conditional credit program ,
Required: False ,
}
string ,
productCode:
{
Description: Product code for the contributor conditional credit ,
Required: False ,
}
string ,
startAt:
{
Description: Start date when the contributor begins contributing ,
Format: date-time ,
Required: False ,
}
string ,
milestones:
{
Description: List of milestones copied from primary conditional credit (excludes award details) ,
Required: False ,
}
[
object ,
]
,
primaryBillingAccountResourceId:
{
Description: Fully-qualified billing account resource identifier of the primary CACO. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Url to get the next page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}