About the examples: Examples and screenshots in this guide use BEAT, a demo company in a Dynamics 365 test environment. Use your own company's codes and values instead of copying them.
Setup steps on this page
Set up Hold reason codes
Use this page to keep the list of reasons that the hold and remove-hold processes ask for.
How to use it
Go to Subscription billing > Recurring contract billing > Setup > Hold reason codes.
Select New and enter the Reason code and a Default comment.
Select the Hold check box so the code is marked for holds on billing schedules.
Save. The code is in the shared Reasons table, so other modules' columns can be set on the same code.
Source: Checked in Dynamics 365
Fields on the page
Field
What it means
Example
Reason code
The code users select.Checked in Dynamics 365
BEAT-HOLD
Default comment
The text that defaults with the code.Checked in Dynamics 365
Hold
Marks the code for holds on billing schedules.Checked in Dynamics 365
Yes
Common errors and fixes
Message
What to do
The new reason code isn't offered in the dialog
This menu item opens the shared Reasons page. Select the module's check box on the code (for example Hold or Termination) to mark it for that use. Checked in Dynamics 365
A short list of hold reasons (for example customer dispute, service outage) with the Hold check box selected.Mass hold processing and Place hold ask for a reason code, and the reason is kept on the schedule's Hold tab.
Subscription billing (Must be on)Recurring contract billing (Must be on)
Licence or add-in
Turn off the Revenue recognition feature first: Subscription billing can't be used while it is on. Then, in Feature management, turn on Subscription billing and after it Recurring contract billing. Revenue recognition was deprecated in January 2024 and replaced by Subscription billing. Subscription billing managers maintain this setup; Subscription billing users can view it.
Reversible: Reason codes can be maintained at any time.
If you change it later
The code is a row in the shared Reasons table; the Hold check box decides that it is used for holds on billing schedules. Renaming or clearing it affects only later selections; recorded reasons stay on the history. Checked in Dynamics 365
Technical architect
6Technical
Menu item
SubBillHoldCodeChecked in Dynamics 365
Form
ReasonsChecked in Dynamics 365
Table
ReasonTableShown as “REASONS” in Record infoChecked in Dynamics 365
Data entities
LedgerFinancialReasonEntityFinancial reasons (the shared reason codes and default comments of the Reasons table) Microsoft data model
Who can open it
PrivilegesSubscription billing manager SubBillBillingMaintainSubscription billing user SubBillBillingViewDutiesSubscription billing user SubBillBillingInquireSubscription billing manager SubBillBillingMaintainSubscription billing module user with capabilities including billing, allocation, and deferral features SubBillInquireSubscription billing allocation, deferral, and billing manager SubBillMaintain4 security rolesSubscription billing manager SubBillBillingMaintainSubscription billing user SubBillBillingViewSubscription billing allocation, deferral, and billing manager SubBillMaintainSubscription billing module user with capabilities including billing, allocation, and deferral features SubBillViewChecked in Dynamics 365
Roles to set it up and use it
To set it up or change itSubscription billing manager SubBillBillingMaintainSubscription billing allocation, deferral, and billing manager SubBillMaintainTo use itSubscription billing user SubBillBillingViewSubscription billing module user with capabilities including billing, allocation, and deferral features SubBillViewGive people one of these roles. On this system, 4 roles can open this page.Checked in Dynamics 365
Developer
7Developer
Open it by URL
https://<your-environment>/?mi=SubBillHoldCode
Data migration
LedgerFinancialReasonEntity (Financial reasons): the shared reason codes, loaded for each company in Microsoft's default template 025 - General ledger.Load order: Load reason codes with the General ledger setup, before billing schedules. Then check the Hold check box on the codes Subscription billing uses.Load first: Legal entitiesMicrosoft Learn