Partner Transfers - Cancel

Service:

Billing

API Version:

2019-10-01-preview

Cancels a transfer request. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

DELETE https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/transfers/{transferName}

URI Parameters

Name	In	Required	Type	Description
billingAccountName	path	True	string	The ID that uniquely identifies a billing account.
billingProfileName	path	True	string	The ID that uniquely identifies a billing profile.
customerName	path	True	string	The ID that uniquely identifies a customer.
transferName	path	True	string	The ID that uniquely identifies a transfer request.

Responses

Name	Type	Description
200 OK	TransferDetails	Details of canceled transfer.
Other Status Codes	ErrorResponse	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

TransferCancel

Sample Request

HTTP

DELETE https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/transfers/transferName

Sample Response

Status code:

200

{
  "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}/customers/{customerName}",
    "transferStatus": "Pending",
    "recipientEmailId": "user@contoso.com",
    "initiatorEmailId": "xyz@contoso.com",
    "canceledBy": "user@contoso.com",
    "lastModifiedTime": "2018-10-10T17:32:28Z"
  }
}

Definitions

Name	Description
DetailedTransferStatus	Detailed transfer status.
Error	Error details for transfer execution.
ErrorDetails	The details of the error.
ErrorResponse	Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.
ErrorSubDetails
productTransferStatus	Transfer status.
productType	Type of the product that is transferred.
TransferDetails	Details of the transfer.
transferStatus	Overall transfer status.

DetailedTransferStatus

Detailed transfer status.

Name	Type	Description
errorDetails	Error	Error details for transfer execution.
productId	string	The ID of the product that is transferred.
productType	productType	Type of product that is transferred.
transferStatus	productTransferStatus	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	ErrorSubDetails[]	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	ErrorDetails	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.

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	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	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