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

Latest commit

 

History

History
26 lines (22 loc) · 3.32 KB

File metadata and controls

26 lines (22 loc) · 3.32 KB

CancellationAmendment

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]
source str { "description" : "Explanation for cancellation", "default" : "API", "verbs":["POST","GET"] }
subscription_cancellation_id str { "description" : "", "verbs":[] } [optional]
service_end str { &quot;description&quot; : &quot;If the serviceEnd parameter is <span class=\&quot;label label-default\&quot;>AtPeriodEnd</span> the cancellation will be delayed till the end of the current period.&quot;, &quot;default&quot; : &quot;AtPeriodEnd&quot;, &quot;verbs&quot;:[&quot;POST&quot;,&quot;GET&quot;] }
cancellation_credit str Specifies whether the service will end immediately on cancellation or if it will continue until the end of the current period. Default: AtPeriodEnd
subscription_cancellation MutableBillingEntity { &quot;description&quot; : &quot;&quot;, &quot;verbs&quot;:[] } [optional]

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