SubscriptionManagementSettings

Represents the settings used to manage recurring subscriptions.

This type extends Metadata and inherits its fields.

In the package manifest, all the settings metadata types for the org are accessed using the “Settings” name. See Settings for more details.

SubscriptionManagementSettings values are stored in the subscriptionmanagement.settings file in the settings folder. The .settings files are different from other named components, because there’s only one settings file for each settings component.

Introduced in API version 55.0.

This metadata type is available with Subscription Management.

• Type: boolean
• Required: No
• Description: Indicates whether document generation is enabled in the org (true) or not (false). The default value is false.

• Type: boolean
• Required: No
• Description: Indicates whether to convert negative invoice lines into a credit note (true) or not (false). This credit note holds a positive balance that you can later use to apply against future invoices. The default value is false.

• Type: boolean
• Required: No
• Description: Indicates whether payments can be applied on the whole invoice (true) or only on invoice lines (false). The default value is false.

• Type: boolean
• Required: No
• Description: Indicates whether the payment schedule and payment schedule item are created automatically (true) or not (false). The default value is false.

• Type: boolean
• Required: No
• Description: Indicates whether refunds are processed automatically (true) or not (false). The default value is false.

• Type: boolean
• Required: No
• Description: Indicates whether the billing schedules in Subscription Management are disabled (true) or not (false). The default value is false.

• Type: boolean
• Required: No
• Description: Indicates whether Subscription Management is enabled (true) or not (false). The default value is false.

This example shows a sample SubscriptionManagementSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<SubscriptionManagementSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <enableSubscriptionManagement>true</enableSubscriptionManagement>
4</SubscriptionManagementSettings>

This example shows a sample package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>SubscriptionManagementSettings</members>
5        <name>Settings</name>
6    </types>
7    <version>68.0</version>
8</Package>

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.