| 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] |
| subscription_charge_id |
String |
{ "description" : "", "verbs":["GET"] } |
[optional] |
| description |
String |
{ "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 |
String |
{ "description" : "", "default" : "Manual", "verbs":[] } |
|
| invoicing_type |
String |
{ "description" : "<span class=\"label label-default\">Immediate</span> invoicing will result in an invoice being issued immediately for the charge. <span class=\"label label-default\">Aggregated</span> invoicing will generate a charge to be added to the next issued invoice, for example at the current billing period end.", "default" : "Aggregated", "verbs":["POST","PUT","GET"] } |
|
| tax_status |
String |
{ "description" : "Whether the amount specified is <span class=\"label label-default\">inclusive</span> or <span class=\"label label-default\">exclusive</span> of tax", "default" : "inclusive", "verbs":["POST","PUT","GET"] } |
|
| subscription_charge |
SubscriptionCharge |
{ "description" : "", "verbs":["GET"] } |
[optional] |
| pricing_component_value_change |
InsertableBillingEntity |
{ "description" : "", "verbs":[] } |
[optional] |
| pricing_component_id |
String |
{ "description" : "", "verbs":[] } |
[optional] |