Skip to content
This repository was archived by the owner on Oct 17, 2023. It is now read-only.

Latest commit

 

History

History
17 lines (13 loc) · 3.09 KB

File metadata and controls

17 lines (13 loc) · 3.09 KB

RecalculateChargeRequest

Properties

Name Type Description Notes
created datetime { "description" : "The UTC DateTime when the object was created.", "verbs":[] } [optional]
name str {"description":"New friendly name given to the charge to help identify it.","verbs":["POST","GET"]} [optional]
description str {"description":"New description given to the charge.","verbs":["POST","GET"]} [optional]
amount float {&quot;description&quot;:&quot;(Applicable only if the existing charge has none of [`pricingComponentName`, `pricingComponentID`] defined)<br>New monetary amount for which to charge. Used only for ad-hoc charges (i.e charges not associated with any pricing component).<br>This amount excludes tax.&quot;,&quot;verbs&quot;:[&quot;POST&quot;,&quot;GET&quot;]} [optional]
invoicing_type str {&quot;default&quot;:&quot;<span class=\&quot;label label-default\&quot;>Aggregated</span>&quot;,&quot;description&quot;:&quot;The strategy for how to raise invoices describing the charges produced by this charge recalculation.<br><span class=\&quot;label label-default\&quot;>Immediate</span> &mdash; Generate straight-away an invoice containing these charges.<br><span class=\&quot;label label-default\&quot;>Aggregated</span> &mdash; Add these charges to the next invoice which is generated naturally &mdash; i.e. the invoice raised at the current period's end.&quot;,&quot;verbs&quot;:[&quot;POST&quot;,&quot;GET&quot;]} [optional]
pricing_component_value int {&quot;description&quot;:&quot;(Applicable only if the existing charge has any of [`pricingComponentName`, `pricingComponentID`] defined)<br>The updated value consumed of the pricing component which this charge concerns.&quot;,&quot;verbs&quot;:[&quot;POST&quot;,&quot;GET&quot;]} [optional]
recalculation_behaviour str {&quot;default&quot;:&quot;RecalculateWithLatestPricing&quot;,&quot;verbs&quot;:[&quot;POST&quot;,&quot;GET&quot;]}
dry_run bool {&quot;default&quot;:false,&quot;description&quot;:&quot;Changes described in the response:<br><span class=\&quot;label label-default\&quot;>true</span> &mdash; Are not actually performed; your subscription remains unchanged, no billing events run, and no invoices are executed.<br><span class=\&quot;label label-default\&quot;>false</span> &mdash; Are actually performed and committed.&quot;,&quot;verbs&quot;:[&quot;POST&quot;,&quot;GET&quot;]} [optional] [default to False]

[Back to Model list] [Back to API list] [Back to README]