| Name | Type | Description | Notes |
|---|---|---|---|
| created | datetime | { "description" : "The UTC DateTime when the object was created.", "verbs":[] } | [optional] |
| periods | int | {"description":"(Required: one of [`periods`, `to`])<br>The number of period boundaries up to which the subscription should advance. A 1-value advances the subscription to the end of its current service period. Higher values advance the subscription to subsequent period boundaries."verbs":["POST","GET"]} | [optional] |
| to | datetime | {"description":"(Required: one of [`periods`, `to`])<br>The time up until which the subscription should be fast-forwarded.","verbs":["POST","GET"]} | [optional] |
| dry_run | bool | {"default":false,"description":"Changes described in the response:<br><span class=\"label label-default\">true</span> — Are not actually performed; your subscription remains unchanged, no billing events run, and no invoices are executed.<br><span class=\"label label-default\">false</span> — Are actually performed and committed.","verbs":["POST","GET"]} | [optional] [default to False] |
| skip_intermediate_periods | bool | {"default":false,"description":"As time scrubs forward:<br><span class=\"label label-default\">true</span> — Raise no invoice upon advancing over a period boundary.<br><span class=\"label label-default\">false</span> — Raise invoices for any period that is entered.","verbs":["POST","GET"]} | [optional] [default to False] |
| handle_amendments | bool | {"default":true,"description":"As time scrubs forward:<br><span class=\"label label-default\">true</span> — Run any amendments that were scheduled to action.<br><span class=\"label label-default\">false</span> — Do not run any amendments that were scheduled to action.","verbs":["POST","GET"]} | [optional] [default to False] |
| execution_strategy | str | {"default":"<span class=\"label label-default\">SingleAttempt</span>","description":"What strategy to use when executing any invoices raised as time advances:<br><span class=\"label label-default\">SingleAttempt</span> — Execute any invoice just once.<br><span class=\"label label-default\">FollowDunning</span> — Apply the existing dunning strategy when executing invoices.<br><span class=\"label label-default\">None</span>: Do not execute invoices.","verbs":["POST","GET"]} | [optional] |
| freeze_on_completion | bool | {"default":false,"description":"Once the subscription is advanced through time:<br><span class=\"label label-default\">true</span> — Freeze the subscription.<br><span class=\"label label-default\">false</span> — Do not freeze the subscription.","verbs":["POST","GET"]} | [optional] [default to False] |
| advance_inclusively | bool | {"default":true,"description":"When advancing onto an instant in time:<br><span class=\"label label-default\">true</span> — Action the events scheduled for your destination time. Amendments scheduled at your destined time will be actioned during this time travel. Advancing to a period boundary will promote your subscription to the period on the future side of that boundary.<br><span class=\"label label-default\">false</span> — Do not action events scheduled for your destination time. Amendments scheduled at your destined time will not be actioned during this time travel. Advancing to a period boundary will result in your subscription's remaining within the period on the past side of that boundary.","verbs":["POST","GET"]} | [optional] [default to False] |
| subscriptions | list[Subscription] | [optional] | |
| invoices | list[Invoice] | [optional] |
This repository has been archived by the owner on Oct 17, 2023. It is now read-only.