Enable or disable an OnOff Feature (write)
set_feature_enabledEnable or disable an OnOff Feature in a customer's active subscription. Use for switchable options; sets the absolute state, so repeating the call is harmless.
Instructions
WRITE. Enables or disables an OnOff Feature in the active subscription of a customer -- an option they switch on or off. OnOff Features only; use add_feature_consumption for a metered Feature and set_feature_current_quantity for a Limitation one. The value is absolute, so repeating the call is harmless. Note that what the application must then enforce is IsEnabled, not IsIncluded: a Feature included in the offer can still be switched off. Quote it first with quote_usage_change when enabling is billable.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| date_stamp | No | When the change happened, ISO 8601 in UTC. Defaults to now. A future date is not supported. | |
| is_enabled | Yes | true to enable the Feature, false to disable it. | |
| feature_ref | Yes | Shared reference of the Feature (ReferenceFeature). | |
| customer_ref | Yes | Shared reference of the customer. | |
| subscription_id | No | Which subscription the Usage belongs to. Needed when the customer has several running. |