Transfers - Initiate
Sends a request to a user in another billing account to transfer billing ownership of their subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/initiateTransfer
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
billing
|
path | True |
string |
The ID that uniquely identifies a billing account. |
billing
|
path | True |
string |
The ID that uniquely identifies a billing profile. |
invoice
|
path | True |
string |
The ID that uniquely identifies an invoice section. |
Request Body
Name | Type | Description |
---|---|---|
properties.recipientEmailId |
string |
The email ID of the recipient to whom the transfer request is sent. |
properties.resellerId |
string |
Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Initiated transfer details. |
|
Other Status Codes |
Unexpected error. |
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
InitiateTransfer
Sample Request
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/initiateTransfer
{
"properties": {
"recipientEmailId": "user@contoso.com"
}
}
Sample Response
{
"properties": {
"creationTime": "2018-10-10T17:32:28Z",
"expirationTime": "2018-11-05T17:32:28Z",
"billingAccountId": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}",
"billingProfileId": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
"invoiceSectionId": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}",
"transferStatus": "Pending",
"recipientEmailId": "user@contoso.com",
"initiatorEmailId": "xyz@contoso.com",
"lastModifiedTime": "2018-10-10T17:32:28Z"
}
}
Definitions
Name | Description |
---|---|
Detailed |
Detailed transfer status. |
Error |
Error details for transfer execution. |
Error |
The details of the error. |
Error |
Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. |
Error |
|
Initiate |
Request parameters to initiate transfer. |
product |
Transfer status. |
product |
Type of the product that is transferred. |
Transfer |
Details of the transfer. |
transfer |
Overall transfer status. |
DetailedTransferStatus
Detailed transfer status.
Name | Type | Description |
---|---|---|
errorDetails |
Error details for transfer execution. |
|
productId |
string |
The ID of the product that is transferred. |
productType |
Type of product that is transferred. |
|
transferStatus |
Transfer status. |
Error
Error details for transfer execution.
Name | Type | Description |
---|---|---|
errorCode |
string |
Error code. |
errorMessage |
string |
Error message. |
ErrorDetails
The details of the error.
Name | Type | Description |
---|---|---|
code |
string |
Error code. |
details |
The sub details of the error. |
|
message |
string |
Error message indicating why the operation failed. |
target |
string |
The target of the particular error. |
ErrorResponse
Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.
Name | Type | Description |
---|---|---|
error |
The details of the error. |
ErrorSubDetails
Name | Type | Description |
---|---|---|
code |
string |
Error code. |
message |
string |
Error message indicating why the operation failed. |
target |
string |
The target of the particular error. |
InitiateTransferRequest
Request parameters to initiate transfer.
Name | Type | Description |
---|---|---|
properties.recipientEmailId |
string |
The email ID of the recipient to whom the transfer request is sent. |
properties.resellerId |
string |
Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. |
productTransferStatus
Transfer status.
Name | Type | Description |
---|---|---|
Completed |
string |
|
Failed |
string |
|
InProgress |
string |
|
NotStarted |
string |
productType
Type of the product that is transferred.
Name | Type | Description |
---|---|---|
AzureReservation |
string |
|
AzureSubscription |
string |
TransferDetails
Details of the transfer.
Name | Type | Description |
---|---|---|
properties.billingAccountId |
string |
The ID of the billing account to which the product is billed after the transfer request is completed. |
properties.billingProfileId |
string |
The ID of the billing profile to which the product will be billed after the transfer. |
properties.canceledBy |
string |
The email ID of the user who canceled the transfer request. |
properties.creationTime |
string |
The time at which the transfer request was created. |
properties.detailedTransferStatus |
Detailed transfer status. |
|
properties.expirationTime |
string |
The time at which the transfer request expires. |
properties.initiatorCustomerType |
string |
The type of customer who sent the transfer request. |
properties.initiatorEmailId |
string |
The email ID of the user who sent the transfer request. |
properties.invoiceSectionId |
string |
The ID of the invoice section to which the product is billed after the transfer request is completed. |
properties.lastModifiedTime |
string |
The time at which the transfer request was last modified. |
properties.recipientEmailId |
string |
The email ID of the user to whom the transfer request was sent. |
properties.resellerId |
string |
Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. |
properties.resellerName |
string |
Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account. |
properties.transferStatus |
Overall transfer status. |
transferStatus
Overall transfer status.
Name | Type | Description |
---|---|---|
Canceled |
string |
|
Completed |
string |
|
CompletedWithErrors |
string |
|
Declined |
string |
|
Failed |
string |
|
InProgress |
string |
|
Pending |
string |