Skip to main content

removeDiscountsFromCharge()

removeDiscountsFromCharge(session, id): Promise< Charge >

Remove all Discounts from a Charge without destroying the Discount. In most cases the Discount should be removed from the Address. When the Discount is removed from the Address, the Discount is also removed from any future Charges. If the Discount is on the parent Address, you cannot remove it using charge_id. When removing your Discount, it is preferable to pass the address_id so that the Discount stays removed if the Charge is regenerated. Only pass charge_id in edge cases in which there are two or more Charges on a parent Address and you only want to remove the Discount from one Charge. If you pass both parameters, it will remove the Discount from the Address.

Parameters

ParameterType
sessionSession
idstring | number

Returns

Promise< Charge >


Generated using typedoc-plugin-markdown and TypeDoc