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

Latest commit

 

History

History
22 lines (19 loc) · 3.13 KB

PricingComponentValueChangeAmendment.md

File metadata and controls

22 lines (19 loc) · 3.13 KB

Bfwd::PricingComponentValueChangeAmendment

Properties

Name Type Description Notes
created DateTime { "description" : "The UTC DateTime when the object was created.", "verbs":[] } [optional]
changed_by String { "description" : "ID of the user who last updated the entity.", "verbs":[] } [optional]
updated DateTime { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] } [optional]
type String { "description" : "", "default" : "", "verbs":["POST","GET"] }
id String { "description" : "", "verbs":["GET"] } [optional]
organization_id String { "description" : "", "verbs":[""] } [optional]
subscription_id String { "description" : "", "verbs":["POST","PUT","GET"] }
amendment_type String { "description" : "Type of amendment", "verbs":["POST","GET"] }
actioning_time DateTime { "description" : "When the amendment will run", "verbs":["POST","PUT","GET"] } [optional]
actioned_time DateTime { "description" : "The time the amendment completed.", "verbs":["GET"] } [optional]
state String Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending
deleted BOOLEAN { "description" : "Is the amendment deleted.", "verbs":["GET"] } [default to false]
invoicing_type String { &quot;description&quot; : &quot;<span class=\&quot;label label-default\&quot;>Immediate</span> generates an invoice straight away for any costs arising from this change, for example upgrade charge. <span class=\&quot;label label-default\&quot;>Aggregated</span> add any upgrade charges to the next invoice, generally this would be at the next period end.&quot;, &quot;default&quot; : &quot;Aggregated&quot;, &quot;verbs&quot;:[&quot;POST&quot;,&quot;GET&quot;] }
invoice_id String { &quot;description&quot; : &quot;Identifer of the invoice with the charges for this change.&quot;, &quot;verbs&quot;:[&quot;GET&quot;] } [optional]
component_changes Array<ComponentChange> { &quot;description&quot; : &quot;Changes to perform, for example upgrade&quot;, &quot;verbs&quot;:[&quot;POST&quot;,&quot;GET&quot;] } [optional]