| 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] |
| product_rate_plan_id | str | { "description" : "Identifier of the rate-plan the subscription to migrate to", "verbs":["POST","GET"] } | |
| invoicing_type | str | { "description" : "<span class=\"label label-default\">Immediate</span> invoicing will result in an invoice being issued immediately for migration charges. <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" : "Immediate", "verbs":["POST","GET"] } | |
| mappings | list[PricingComponentValueMigrationAmendmentMapping] | { "description" : "Mapping of new rate-plans pricing-components to values", "verbs":["POST","GET"] } | [optional] |
| previous_subscription_id | str | { "description" : "ID of the previous subscription.", "verbs":["GET"] } | [optional] |
| next_subscription_id | str | { "description" : "ID of the next subscription.", "verbs":["GET"] } | [optional] |
| next_subscription_name | str | { "description" : "User definable friendly name for the migrated subscription.", "verbs":["POST","GET"] } | [optional] |
| next_subscription_description | str | { "description" : "User definable description for the migrated subscription.", "verbs":["POST","GET"] } | [optional] |
| pricing_behaviour | str | { "description" : "Pricing behaviour defines how migration charges are calculated. <span class=\"label label-default\">DifferenceProRated</span> calculates the difference between in-advance charges of the existing and new rate-plan, then pro-rates based on time remaining. <span class=\"label label-default\">None</span> sets the migration charge as zero cost. <span class=\"label label-default\">Full</span> sets the costs as the total of the new rate-plans in-advance charges. <span class=\"label label-default\">Difference</span> is the same calculation as <span class=\"label label-default\">DifferenceProRated</span> but no pro-ration is applied. <span class=\"label label-default\">ProRated</span> differs depending on two cases; when moving to a rate-plan of the same duration it pro-rates the in-advance charges of the new rate-plan. If the duration is different, a credit-note will be issued any remaining time on the existing plans billing period.", "default" : "DifferenceProRated", "verbs":["POST","GET"] } |
This repository was archived by the owner on Oct 17, 2023. It is now read-only.