| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | {"description":"ID of the Subscription you wish to update.","verbs":["POST"]} | |
| name | String | {"description":"New name to assign to the updated subscription. This is primarily for your benefit — for example, to enable you to identify subscriptions at a glance in the BillForward web interface (e.g. 'Customer 1425, guy@mail.com, Premium membership').","verbs":["POST"]} | [optional] |
| description | String | {"description":"New description to assign to the updated subscription. This is primarily for your benefit — for example, you could write here the mechanism through which you obtained this customer. (e.g. 'Customer obtained through Lazy Wednesdays promotion').","verbs":["POST"]} | [optional] |
| start | DateTime | {"description":"[Can only be changed if subscription is still in Provisioned state] ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should enter its first service period.","verbs":["POST"]} | [optional] |
| _end | DateTime | {"description":"[Can only be changed if subscription is still in Provisioned state] ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should finish its first service period.","verbs":["POST"]} | [optional] |
| state | String | {"description":"[Can only be changed if subscription is still in Provisioned state] The state into which you wish to move the updated subscription.<br><span class=\"label label-default\">AwaitingPayment</span> — The subscription is activated. After `start` time is surpassed, it will begin service and raise its first invoice.","verbs":["POST"]} | [optional] |
| parent_id | String | {"description":"ID of a parent subscription which will collect the charges raised by this subscription. The parent becomes responsible for paying those charges.","verbs":["POST"]} | [optional] |
| aggregate_all_subscriptions_on_account | BOOLEAN | {"description":"Whether this subscription should become an 'aggregating subscription', collecting charges (starting now) from all other subscriptions (current and future) belonging to this BillForward Account.","verbs":["POST"]} | [optional] [default to false] |
| failed_payment_behaviour | String | {"default":"None","description":"The action that should be taken, should an invoice for some subscription to this rate plan remain unpaid despite the dunning period's being exceeded.<br><span class=\"label label-default\">CancelSubscription</span> — Demotes the subscription to the `Failed` state as soon as the dunning period is exceeded.<br><span class=\"label label-default\">None</span> — The subscription is allowed to continue in the `AwaitingPayment` state indefinitely even if the dunning period is exceeded.For slow payment cycles — or when manual invoice remediation is common — <span class=\"label label-default\">None</span> is recommended.<br>In a heavily-automated SaaS environment, automatic cancellation via <span class=\"label label-default\">CancelSubscription</span> is recommended.","verbs":["POST","PUT","GET"]} | [optional] |
This repository was archived by the owner on Oct 17, 2023. It is now read-only.