Microsoft.Subscription (preview:2025-11-01)

2025/12/08 • 21 new methods

Subscription_Cancel (new)
Description :  The operation to cancel a subscription
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Subscription/cancel
{
subscriptionId:
{
Description: Subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2025-11-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
subscriptionId:
{
Description: The ID of the canceled subscription ,
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 ,
}
,
]
,
}
,
}
Subscription_Rename (new)
Description :  The operation to rename a subscription
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Subscription/rename
{
subscriptionId:
{
Description: Subscription Id. ,
Required: True ,
}
string ,
body:
{
Description: Subscription Name ,
Required: True ,
}
{
subscriptionName:
{
Description: New subscription name ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2025-11-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
subscriptionId:
{
Description: The ID of the subscriptions that is being renamed ,
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 ,
}
,
]
,
}
,
}
Subscription_Enable (new)
Description :  The operation to enable a subscription
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Subscription/enable
{
subscriptionId:
{
Description: Subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2025-11-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
subscriptionId:
{
Description: The ID of the subscriptions that is being enabled ,
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 ,
}
,
]
,
}
,
}
SubscriptionOperation_Get (new)
Description :  Get the status of the pending Microsoft.Subscription API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Subscription/subscriptionOperations/{operationId}
{
operationId:
{
Description: The operation ID, which can be found from the Location field in the generate recommendation response header. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2025-11-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
subscriptionLink:
{
Description: The link to the new subscription. Use this link to check the status of subscription creation operation. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The URL where the status of the asynchronous operation can be checked. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
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 ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  Lists all of the available Microsoft.Subscription API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Subscription/operations
{
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2025-11-01-preview ,
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 ,
}
,
]
,
}
,
}
Alias_Create (new)
Description :  Create Alias Subscription.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Subscription/aliases/{aliasName}
{
aliasName:
{
Description: AliasName is the name for the subscription creation request. Note that this is not the same as subscription name and this doesn’t have any other lifecycle need beyond the request for subscription creation. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
properties:
{
Description: Put alias request properties. ,
Required: False ,
}
{
displayName:
{
Description: The friendly name of the subscription. ,
Required: False ,
}
string ,
workload:
{
Description: The workload type of the subscription. It can be either Production or DevTest. ,
Enum:
{
Production: No description available. ,
DevTest: No description available. ,
}
,
Required: False ,
}
enum ,
billingScope:
{
Description: Billing scope of the subscription. For CustomerLed and FieldLed - /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} For PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} For Legacy EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName} ,
Required: False ,
}
string ,
subscriptionId:
{
Description: This parameter can be used to create alias for existing subscription Id ,
Required: False ,
}
string ,
resellerId:
{
Description: Reseller Id ,
Required: False ,
}
string ,
additionalProperties:
{
Description: Put alias request additional properties. ,
Required: False ,
}
{
managementGroupId:
{
Description: Management group Id for the subscription. ,
Required: False ,
}
string ,
subscriptionTenantId:
{
Description: Tenant Id of the subscription ,
Required: False ,
}
string ,
subscriptionOwnerId:
{
Description: Owner Id of the subscription ,
Required: False ,
}
string ,
tags:
{
Description: Tags for the subscription ,
Required: False ,
}
object ,
}
,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2025-11-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified ID for the alias resource. ,
Required: False ,
}
string ,
name:
{
Description: Alias ID. ,
Required: False ,
}
string ,
type:
{
Description: Resource type, Microsoft.Subscription/aliases. ,
Required: False ,
}
string ,
properties:
{
Description: Subscription Alias response properties. ,
Required: False ,
}
{
subscriptionId:
{
Description: Newly created subscription Id. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
acceptOwnershipUrl:
{
Description: Url to accept ownership of the subscription. ,
Required: False ,
}
string ,
acceptOwnershipState:
{
Description: The accept ownership state of the resource. ,
Enum:
{
Pending: No description available. ,
Completed: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
billingScope:
{
Description: Billing scope of the subscription. For CustomerLed and FieldLed - /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} For PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} For Legacy EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName} ,
Required: False ,
}
string ,
workload:
{
Description: The workload type of the subscription. It can be either Production or DevTest. ,
Enum:
{
Production: No description available. ,
DevTest: No description available. ,
}
,
Required: False ,
}
enum ,
resellerId:
{
Description: Reseller Id ,
Required: False ,
}
string ,
subscriptionOwnerId:
{
Description: Owner Id of the subscription ,
Required: False ,
}
string ,
managementGroupId:
{
Description: The Management Group Id. ,
Required: False ,
}
string ,
createdTime:
{
Description: Created Time ,
Required: False ,
}
string ,
tags:
{
Description: Tags for the subscription ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
id:
{
Description: Fully qualified ID for the alias resource. ,
Required: False ,
}
string ,
name:
{
Description: Alias ID. ,
Required: False ,
}
string ,
type:
{
Description: Resource type, Microsoft.Subscription/aliases. ,
Required: False ,
}
string ,
properties:
{
Description: Subscription Alias response properties. ,
Required: False ,
}
{
subscriptionId:
{
Description: Newly created subscription Id. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
acceptOwnershipUrl:
{
Description: Url to accept ownership of the subscription. ,
Required: False ,
}
string ,
acceptOwnershipState:
{
Description: The accept ownership state of the resource. ,
Enum:
{
Pending: No description available. ,
Completed: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
billingScope:
{
Description: Billing scope of the subscription. For CustomerLed and FieldLed - /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} For PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} For Legacy EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName} ,
Required: False ,
}
string ,
workload:
{
Description: The workload type of the subscription. It can be either Production or DevTest. ,
Enum:
{
Production: No description available. ,
DevTest: No description available. ,
}
,
Required: False ,
}
enum ,
resellerId:
{
Description: Reseller Id ,
Required: False ,
}
string ,
subscriptionOwnerId:
{
Description: Owner Id of the subscription ,
Required: False ,
}
string ,
managementGroupId:
{
Description: The Management Group Id. ,
Required: False ,
}
string ,
createdTime:
{
Description: Created Time ,
Required: False ,
}
string ,
tags:
{
Description: Tags for the subscription ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Subscription/aliases/{aliasName}
{
aliasName:
{
Description: AliasName is the name for the subscription creation request. Note that this is not the same as subscription name and this doesn’t have any other lifecycle need beyond the request for subscription creation. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2025-11-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified ID for the alias resource. ,
Required: False ,
}
string ,
name:
{
Description: Alias ID. ,
Required: False ,
}
string ,
type:
{
Description: Resource type, Microsoft.Subscription/aliases. ,
Required: False ,
}
string ,
properties:
{
Description: Subscription Alias response properties. ,
Required: False ,
}
{
subscriptionId:
{
Description: Newly created subscription Id. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
acceptOwnershipUrl:
{
Description: Url to accept ownership of the subscription. ,
Required: False ,
}
string ,
acceptOwnershipState:
{
Description: The accept ownership state of the resource. ,
Enum:
{
Pending: No description available. ,
Completed: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
billingScope:
{
Description: Billing scope of the subscription. For CustomerLed and FieldLed - /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} For PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} For Legacy EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName} ,
Required: False ,
}
string ,
workload:
{
Description: The workload type of the subscription. It can be either Production or DevTest. ,
Enum:
{
Production: No description available. ,
DevTest: No description available. ,
}
,
Required: False ,
}
enum ,
resellerId:
{
Description: Reseller Id ,
Required: False ,
}
string ,
subscriptionOwnerId:
{
Description: Owner Id of the subscription ,
Required: False ,
}
string ,
managementGroupId:
{
Description: The Management Group Id. ,
Required: False ,
}
string ,
createdTime:
{
Description: Created Time ,
Required: False ,
}
string ,
tags:
{
Description: Tags for the subscription ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /providers/Microsoft.Subscription/aliases/{aliasName}
{
aliasName:
{
Description: AliasName is the name for the subscription creation request. Note that this is not the same as subscription name and this doesn’t have any other lifecycle need beyond the request for subscription creation. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2025-11-01-preview ,
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 ,
}
,
]
,
}
,
}
Alias_List (new)
Description :  List Alias Subscription.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Subscription/aliases
{
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2025-11-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of alias. ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified ID for the alias resource. ,
Required: False ,
}
string ,
name:
{
Description: Alias ID. ,
Required: False ,
}
string ,
type:
{
Description: Resource type, Microsoft.Subscription/aliases. ,
Required: False ,
}
string ,
properties:
{
Description: Subscription Alias response properties. ,
Required: False ,
}
{
subscriptionId:
{
Description: Newly created subscription Id. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the subscription. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
acceptOwnershipUrl:
{
Description: Url to accept ownership of the subscription. ,
Required: False ,
}
string ,
acceptOwnershipState:
{
Description: The accept ownership state of the resource. ,
Enum:
{
Pending: No description available. ,
Completed: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
billingScope:
{
Description: Billing scope of the subscription. For CustomerLed and FieldLed - /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} For PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} For Legacy EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName} ,
Required: False ,
}
string ,
workload:
{
Description: The workload type of the subscription. It can be either Production or DevTest. ,
Enum:
{
Production: No description available. ,
DevTest: No description available. ,
}
,
Required: False ,
}
enum ,
resellerId:
{
Description: Reseller Id ,
Required: False ,
}
string ,
subscriptionOwnerId:
{
Description: Owner Id of the subscription ,
Required: False ,
}
string ,
managementGroupId:
{
Description: The Management Group Id. ,
Required: False ,
}
string ,
createdTime:
{
Description: Created Time ,
Required: False ,
}
string ,
tags:
{
Description: Tags for the subscription ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

POST:  /providers/Microsoft.Subscription/subscriptions/{subscriptionId}/acceptOwnership
{
subscriptionId:
{
Description: Subscription Id. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
properties:
{
Description: Accept subscription ownership request properties. ,
Required: False ,
}
{
displayName:
{
Description: The friendly name of the subscription. ,
Required: True ,
}
string ,
managementGroupId:
{
Description: Management group Id for the subscription. ,
Required: False ,
}
string ,
tags:
{
Description: Tags for the subscription ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2025-11-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: GET this URL to retrieve the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
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 ,
}
,
]
,
}
,
}
Subscription_AcceptOwnershipStatus (new)
Description :  Accept subscription ownership status.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Subscription/subscriptions/{subscriptionId}/acceptOwnershipStatus
{
subscriptionId:
{
Description: Subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2025-11-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
subscriptionId:
{
Description: Newly created subscription Id. ,
Required: False ,
}
string ,
acceptOwnershipState:
{
Description: The accept ownership state of the resource. ,
Enum:
{
Pending: No description available. ,
Completed: No description available. ,
Expired: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Pending: No description available. ,
Accepted: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
billingOwner:
{
Description: UPN of the billing owner ,
Required: False ,
}
string ,
subscriptionTenantId:
{
Description: Tenant Id of the subscription ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the subscription. ,
Required: False ,
}
string ,
tags:
{
Description: Tags for the subscription ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SubscriptionPolicy_AddUpdatePolicyForTenant (new)
Description :  Create or Update Subscription tenant policy for user's tenant.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Subscription/policies/default
{
body:
{
Required: True ,
}
{
blockSubscriptionsLeavingTenant:
{
Description: Blocks the leaving of subscriptions from user's tenant. ,
Required: False ,
}
boolean ,
blockSubscriptionsIntoTenant:
{
Description: Blocks the entering of subscriptions into user's tenant. ,
Required: False ,
}
boolean ,
exemptedPrincipals:
{
Description: List of user objectIds that are exempted from the set subscription tenant policies for the user's tenant. ,
Required: False ,
}
[
string ,
]
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2025-11-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Policy Id. ,
Required: False ,
}
string ,
name:
{
Description: Policy name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Tenant policy properties. ,
Required: False ,
}
{
policyId:
{
Description: Policy Id. ,
Required: False ,
}
string ,
blockSubscriptionsLeavingTenant:
{
Description: Blocks the leaving of subscriptions from user's tenant. ,
Required: False ,
}
boolean ,
blockSubscriptionsIntoTenant:
{
Description: Blocks the entering of subscriptions into user's tenant. ,
Required: False ,
}
boolean ,
exemptedPrincipals:
{
Description: List of user objectIds that are exempted from the set subscription tenant policies for the user's tenant. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SubscriptionPolicy_GetPolicyForTenant (new)
Description :  Get the subscription tenant policy for the user's tenant.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Subscription/policies/default
{
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2025-11-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Policy Id. ,
Required: False ,
}
string ,
name:
{
Description: Policy name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Tenant policy properties. ,
Required: False ,
}
{
policyId:
{
Description: Policy Id. ,
Required: False ,
}
string ,
blockSubscriptionsLeavingTenant:
{
Description: Blocks the leaving of subscriptions from user's tenant. ,
Required: False ,
}
boolean ,
blockSubscriptionsIntoTenant:
{
Description: Blocks the entering of subscriptions into user's tenant. ,
Required: False ,
}
boolean ,
exemptedPrincipals:
{
Description: List of user objectIds that are exempted from the set subscription tenant policies for the user's tenant. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SubscriptionPolicy_ListPolicyForTenant (new)
Description :  Get the subscription tenant policy for the user's tenant.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Subscription/policies
{
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2025-11-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of tenant policies. ,
Required: False ,
}
[
{
id:
{
Description: Policy Id. ,
Required: False ,
}
string ,
name:
{
Description: Policy name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Tenant policy properties. ,
Required: False ,
}
{
policyId:
{
Description: Policy Id. ,
Required: False ,
}
string ,
blockSubscriptionsLeavingTenant:
{
Description: Blocks the leaving of subscriptions from user's tenant. ,
Required: False ,
}
boolean ,
blockSubscriptionsIntoTenant:
{
Description: Blocks the entering of subscriptions into user's tenant. ,
Required: False ,
}
boolean ,
exemptedPrincipals:
{
Description: List of user objectIds that are exempted from the set subscription tenant policies for the user's tenant. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Subscription/policies/default
{
billingAccountId:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2025-11-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified ID for the policy. ,
Required: False ,
}
string ,
name:
{
Description: Policy name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
properties:
{
Description: Billing account policies response properties. ,
Required: False ,
}
{
serviceTenants:
{
Description: Service tenant for the billing account. ,
Required: False ,
}
[
{
tenantId:
{
Description: Service tenant id. ,
Required: False ,
}
string ,
tenantName:
{
Description: Service tenant name. ,
Required: False ,
}
string ,
}
,
]
,
allowTransfers:
{
Description: Determine if the transfers are allowed for the billing account ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Subscriptions_PutTargetDirectory (new)
Description :  The operation to initiate Subscription Changed Request
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Subscription/changeTenantRequest/default
{
subscriptionId:
{
Description: Subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2025-11-01-preview ,
Required: True ,
}
string ,
body:
{
Description: Target Directory Request ,
Required: True ,
}
{
properties:
{
Description: Target Directory request properties. ,
Required: False ,
}
{
destinationOwnerId:
{
Description: The destination OwnerId, can be object id or email address ,
Required: False ,
}
string ,
destinationTenantId:
{
Description: The destination Tenant id where subscription needs to be accepted ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified ID for the Subscription Changed Directory resource. ,
Required: False ,
}
string ,
name:
{
Description: Subscription Name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type, Microsoft.Subscription/changeTenantRequest. ,
Required: False ,
}
string ,
properties:
{
Description: Subscription Changed Target Directory response properties. ,
Required: False ,
}
{
destinationTenantId:
{
Description: Destination Tenant Id where Subscription will be accepted. ,
Required: False ,
}
string ,
destinationOwnerId:
{
Description: Destination Owner Id where Subscription will be accepted. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The id of the subscription being transferred. ,
Required: False ,
}
string ,
createdDate:
{
Description: The UTC date and time when the transfer request was created ,
Format: date-time ,
Required: False ,
}
string ,
acceptedDate:
{
Description: The UTC date and time when the transfer request was accepted ,
Format: date-time ,
Required: False ,
}
string ,
sourceOwnerEmail:
{
Description: The email address of the user who initiated the transfer request. If the request was generated by a Service Principal, this field may be null. ,
Required: False ,
}
string ,
sourceOwnerId:
{
Description: The object id of the user who initiated the transfer request. ,
Required: False ,
}
string ,
sourceTenantId:
{
Description: The id of the tenant where the subscription originally resided. ,
Required: False ,
}
string ,
status:
{
Description: Status of the subscription transfer operation. ,
Enum:
{
Initialized: The subscription transfer request has been created and is waiting for acceptance by the destination tenant. ,
InProgress: The subscription transfer request has been accepted by the destination tenant and the transfer is in progress. ,
Completed: The subscription transfer has been completed and is now owned by the destination tenant. ,
}
,
Required: False ,
}
enum ,
expiresOn:
{
Description: Subscription Initiate Request Expiry time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Subscriptions_GetTargetDirectory (new)
Description :  The operation to view Initiator Subscription Changed Request
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Subscription/changeTenantRequest/default
{
subscriptionId:
{
Description: Subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2025-11-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified ID for the Subscription Changed Directory resource. ,
Required: False ,
}
string ,
name:
{
Description: Subscription Name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type, Microsoft.Subscription/changeTenantRequest. ,
Required: False ,
}
string ,
properties:
{
Description: Subscription Changed Target Directory response properties. ,
Required: False ,
}
{
destinationTenantId:
{
Description: Destination Tenant Id where Subscription will be accepted. ,
Required: False ,
}
string ,
destinationOwnerId:
{
Description: Destination Owner Id where Subscription will be accepted. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The id of the subscription being transferred. ,
Required: False ,
}
string ,
createdDate:
{
Description: The UTC date and time when the transfer request was created ,
Format: date-time ,
Required: False ,
}
string ,
acceptedDate:
{
Description: The UTC date and time when the transfer request was accepted ,
Format: date-time ,
Required: False ,
}
string ,
sourceOwnerEmail:
{
Description: The email address of the user who initiated the transfer request. If the request was generated by a Service Principal, this field may be null. ,
Required: False ,
}
string ,
sourceOwnerId:
{
Description: The object id of the user who initiated the transfer request. ,
Required: False ,
}
string ,
sourceTenantId:
{
Description: The id of the tenant where the subscription originally resided. ,
Required: False ,
}
string ,
status:
{
Description: Status of the subscription transfer operation. ,
Enum:
{
Initialized: The subscription transfer request has been created and is waiting for acceptance by the destination tenant. ,
InProgress: The subscription transfer request has been accepted by the destination tenant and the transfer is in progress. ,
Completed: The subscription transfer has been completed and is now owned by the destination tenant. ,
}
,
Required: False ,
}
enum ,
expiresOn:
{
Description: Subscription Initiate Request Expiry time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Subscriptions_DeleteTargetDirectory (new)
Description :  The operation to delete Initiator Subscription Changed Request
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.Subscription/changeTenantRequest/default
{
subscriptionId:
{
Description: Subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2025-11-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Subscriptions_ListTargetDirectory (new)
Description :  The operation to list Initiator Subscription Changed Request
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Subscription/changeTenantRequest
{
subscriptionId:
{
Description: Subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2025-11-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of subscription response to changed target directory. ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified ID for the Subscription Changed Directory resource. ,
Required: False ,
}
string ,
name:
{
Description: Subscription Name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type, Microsoft.Subscription/changeTenantRequest. ,
Required: False ,
}
string ,
properties:
{
Description: Subscription Changed Target Directory response properties. ,
Required: False ,
}
{
destinationTenantId:
{
Description: Destination Tenant Id where Subscription will be accepted. ,
Required: False ,
}
string ,
destinationOwnerId:
{
Description: Destination Owner Id where Subscription will be accepted. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The id of the subscription being transferred. ,
Required: False ,
}
string ,
createdDate:
{
Description: The UTC date and time when the transfer request was created ,
Format: date-time ,
Required: False ,
}
string ,
acceptedDate:
{
Description: The UTC date and time when the transfer request was accepted ,
Format: date-time ,
Required: False ,
}
string ,
sourceOwnerEmail:
{
Description: The email address of the user who initiated the transfer request. If the request was generated by a Service Principal, this field may be null. ,
Required: False ,
}
string ,
sourceOwnerId:
{
Description: The object id of the user who initiated the transfer request. ,
Required: False ,
}
string ,
sourceTenantId:
{
Description: The id of the tenant where the subscription originally resided. ,
Required: False ,
}
string ,
status:
{
Description: Status of the subscription transfer operation. ,
Enum:
{
Initialized: The subscription transfer request has been created and is waiting for acceptance by the destination tenant. ,
InProgress: The subscription transfer request has been accepted by the destination tenant and the transfer is in progress. ,
Completed: The subscription transfer has been completed and is now owned by the destination tenant. ,
}
,
Required: False ,
}
enum ,
expiresOn:
{
Description: Subscription Initiate Request Expiry time ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Subscriptions_AcceptTargetDirectory (new)
Description :  The operation to accept Subscription Changed Request
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Subscription/subscriptions/{subscriptionId}/acceptChangeTenant
{
subscriptionId:
{
Description: Subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2025-11-01-preview ,
Required: True ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Subscriptions_TargetDirectoryStatus (new)
Description :  The operation for Acceptor to view the accepted request
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Subscription/subscriptions/{subscriptionId}/changeTenantStatus
{
subscriptionId:
{
Description: Subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2025-11-01-preview ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
destinationTenantId:
{
Description: Destination Tenant Id where Subscription will be accepted. ,
Required: False ,
}
string ,
destinationOwnerId:
{
Description: Destination Owner Id where Subscription will be accepted. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The id of the subscription being transferred. ,
Required: False ,
}
string ,
createdDate:
{
Description: The UTC date and time when the transfer request was created ,
Format: date-time ,
Required: False ,
}
string ,
acceptedDate:
{
Description: The UTC date and time when the transfer request was accepted ,
Format: date-time ,
Required: False ,
}
string ,
sourceOwnerEmail:
{
Description: The email address of the user who initiated the transfer request. If the request was generated by a Service Principal, this field may be null. ,
Required: False ,
}
string ,
sourceOwnerId:
{
Description: The object id of the user who initiated the transfer request. ,
Required: False ,
}
string ,
sourceTenantId:
{
Description: The id of the tenant where the subscription originally resided. ,
Required: False ,
}
string ,
status:
{
Description: Status of the subscription transfer operation. ,
Enum:
{
Initialized: The subscription transfer request has been created and is waiting for acceptance by the destination tenant. ,
InProgress: The subscription transfer request has been accepted by the destination tenant and the transfer is in progress. ,
Completed: The subscription transfer has been completed and is now owned by the destination tenant. ,
}
,
Required: False ,
}
enum ,
expiresOn:
{
Description: Subscription Initiate Request Expiry time ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

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