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

Latest commit

 

History

History
31 lines (27 loc) · 4.45 KB

File metadata and controls

31 lines (27 loc) · 4.45 KB

CreateSubscriptionChargeAmendment

Properties

Name Type Description Notes
created datetime { "description" : "The UTC DateTime when the object was created.", "verbs":[] } [optional]
changed_by str { "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 str { "description" : "", "default" : "", "verbs":["POST","GET"] }
id str { "description" : "", "verbs":["GET"] } [optional]
organization_id str { "description" : "", "verbs":[""] } [optional]
subscription_id str { "description" : "", "verbs":["POST","PUT","GET"] }
amendment_type str { "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 str 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 bool { "description" : "Is the amendment deleted.", "verbs":["GET"] } [default to False]
subscription_charge_id str { "description" : "", "verbs":["GET"] } [optional]
description str { "description" : ".", "verbs":["POST","GET"] } [optional]
amount float { "description" : "Monetary value to charge in the same currency as the subscription.", "verbs":["POST","GET"] }
discount float { "description" : "", "verbs":[] } [optional]
type str { "description" : "", "default" : "Manual", "verbs":[] }
invoicing_type str { &quot;description&quot; : &quot;<span class=\&quot;label label-default\&quot;>Immediate</span> invoicing will result in an invoice being issued immediately for the charge. <span class=\&quot;label label-default\&quot;>Aggregated</span> invoicing will generate a charge to be added to the next issued invoice, for example at the current billing period end.&quot;, &quot;default&quot; : &quot;Aggregated&quot;, &quot;verbs&quot;:[&quot;POST&quot;,&quot;PUT&quot;,&quot;GET&quot;] }
tax_status str { &quot;description&quot; : &quot;Whether the amount specified is <span class=\&quot;label label-default\&quot;>inclusive</span> or <span class=\&quot;label label-default\&quot;>exclusive</span> of tax&quot;, &quot;default&quot; : &quot;inclusive&quot;, &quot;verbs&quot;:[&quot;POST&quot;,&quot;PUT&quot;,&quot;GET&quot;] }
subscription_charge SubscriptionCharge { &quot;description&quot; : &quot;&quot;, &quot;verbs&quot;:[&quot;GET&quot;] } [optional]
pricing_component_value_change InsertableBillingEntity { &quot;description&quot; : &quot;&quot;, &quot;verbs&quot;:[] } [optional]
pricing_component_id str { &quot;description&quot; : &quot;&quot;, &quot;verbs&quot;:[] } [optional]

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