Billing Subscriptions - Transfer

Service:

Billing

API Version:

2019-10-01-preview

Moves a subscription's charges to a new invoice section. The new invoice section must belong to the same billing profile as the existing invoice section. This operation is supported only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingSubscriptions/{billingSubscriptionName}/transfer

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.
billingSubscriptionName	path	True	string	The ID that uniquely identifies a subscription.
invoiceSectionName	path	True	string	The ID that uniquely identifies an invoice section.

Request Body

Name	Type	Description
destinationBillingProfileId	string	The destination billing profile id.
destinationInvoiceSectionId	string	The destination invoice section id.

Responses

Name	Type	Description
200 OK	TransferBillingSubscriptionResult	OK. The request has succeeded.
202 Accepted		Accepted. Billing Subscription transfer is in progress. Headers Location: string Retry-After: integer
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

TransferBillingSubscription

Sample Request

HTTP

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingSubscriptions/{billingSubscriptionName}/transfer

{
  "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{newInvoiceSectionName}",
  "destinationBillingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{newBillingProfileName}"
}

Sample Response

Status code:

200

{
  "properties": {
    "billingSubscriptionName": "Test subscription"
  }
}

Status code:

202

Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingSubscriptions/{billingSubscriptionName}/transfer/operationResults/10000000-0000-0000-0000-000000000001?api-version=2019-10-01-preview
Retry-After: 30

Definitions

Name	Description
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
TransferBillingSubscriptionRequestProperties	Request parameters to transfer billing subscription.
TransferBillingSubscriptionResult	Result of the transfer billing subscription operation.

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.

TransferBillingSubscriptionRequestProperties

Request parameters to transfer billing subscription.

Name	Type	Description
destinationBillingProfileId	string	The destination billing profile id.
destinationInvoiceSectionId	string	The destination invoice section id.

TransferBillingSubscriptionResult

Result of the transfer billing subscription operation.

Name	Type	Description
properties.billingSubscriptionName	string	The destination billing subscription id.