| Name | Type | Description | Notes |
|---|---|---|---|
| created | datetime | { "description" : "The UTC DateTime when the object was created.", "verbs":[] } | [optional] |
| value | int | {"default":"<span class=\"label label-default\"></span>","description":"Modifies the current value used to calculate the recurring costs of the subscription. This can effectively be thought of as an upsert.Note: altering costs on invoices are made be editing charges.<br><span class=\"label label-default\">Setup Pricing</span> — Value changed if initial invoice has not been issued.<br><span class=\"label label-default\">In-Advance/Subscription Pricing</span> — Value changed and a charge added. If the change is delayed the current value on the subscription will show the delayed change.<br><span class=\"label label-default\">Arrears Pricing</span> — Value updated, and a pro-rated charge added to the subscription if required.<br><span class=\"label label-default\">Usage Pricing</span> — Usage created or updated for the current billing cycle.which is generated naturally — i.e. the invoice raised at the current period's end.","verbs":["POST","GET"]} | |
| change_mode | str | {"default":"<span class=\"label label-default\">as on pricing component</span>","description":"Default behaviour when a value is changed by default the change mode from the pricing component is used.<br><span class=\"label label-default\">immediate</span> — Change will apply at the time the request is made.<br><span class=\"label label-default\">delayed</span> — Change will apply at the end of the current billing cycle.","verbs":["POST","GET"]} | [optional] |
| invoicing_type | str | {"default":"<span class=\"label label-default\">Aggregated</span>","description":"If the change results in a charge should it be invoiced straight away or on the next invoice.<br><span class=\"label label-default\">Immediate</span> — If the change has a cost associated with it , for example a pro-rated upgrade charge, an invoice will be raised at the time the request is made. If the invoice fails to be paid the upgrade will fail and the invoice will be voided. No credit or refund is issued for immediate downgrades.<br><span class=\"label label-default\">Aggregated</span> — If the change has a cost associated with it , for example a pro-rated upgrade charge, the charge will be added to the next invoice raised for this subscription. As no payment is required when the change is request the change always succeeds.","verbs":["POST","GET"]} | [optional] |
| no_charge | bool | {"default":"<span class=\"label label-default\">false</span>","description":"If specified the change will have no cost associated with it. This is useful for immediately changing a value without creating any upgrade charge.","verbs":["POST","GET"]} | [optional] [default to False] |
This repository has been archived by the owner on Oct 17, 2023. It is now read-only.