| Name | Type | Description | Notes |
|---|---|---|---|
| account_id | String | {"description":"ID of the BillForward Account who will own this subscription. You should ensure beforehand that the customer has had a BillForward Account created for them.","verbs":["POST"]} | |
| product | String | {"description":"Name or ID of the product.","verbs":["POST"]} | |
| product_rate_plan | String | {"description":"ID or name of the rate plan to which the subscription will be subscribing. Lookup by name is only possible if a `productID` is specified.","verbs":["POST"]} | |
| organization_id | String | {"default":"(Auto-populated using your authentication credentials)","description":"ID of the BillForward Organization within which the requested Subscription should be created. If omitted, this will be auto-populated using your authentication credentials.","verbs":["POST"]} | [optional] |
| name | String | {"default":"(Subscription will be named after the rate plan to which the subscription subscribes)","description":"Name of the created 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 | {"default":"(null)","description":"Description of the created 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 | {"default":"(ServerNow upon receiving request)","description":"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 | {"default":"(1 period ahead of the `start` time)","description":"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 | {"default":"Provisioned","description":"The state in which the created subscription will begin.<br><span class=\"label label-default\">Provisioned</span> — The subscription will wait (without raising any invoices or beginning its service) until explicit action is taken to change its state.<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] |
| trial_end | DateTime | {"default":"(null)","description":"ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should leave the trial period.","verbs":["POST"]} | [optional] |
| type | String | [optional] | |
| parent_id | String | {"default":"(If a subscription exists which 'aggregates all subscriptions belonging to this BillForward Account', refer to the ID of that subscription. Otherwise: null)","description":"ID of a parent subscription which will collect the charges raised by this subscription. The parent becomes responsible for paying those charges. If a subscription exists which 'aggregates all subscriptions belonging to this BillForward Account', then that parent will override any parent specified here.","verbs":["POST"]} | [optional] |
| aggregate_all_subscriptions_on_account | BOOLEAN | {"default":false,"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] |
| align_period_with_aggregating_subscription | BOOLEAN | {"default":true,"description":"Whether to override the `end` date to line up with the current period end of the 'aggregating subscription' to which this subscription belongs.","verbs":["POST"]} | [optional] [default to false] |
| pricing_component_quantities | Array<PricingComponentQuantityRequest> | {"default":"(empty list)","description":"Quantities that this subscription possesses (upon beginning service), of pricing components upon the subscription's rate plan. For example: you can set the subscription to begin its service with '5 widgets' consumed. Otherwise the 'default quantity' will be observed instead, for each pricing component upon the rate plan.","verbs":["POST"]} | [optional] |
| metadata | DynamicMetadata | { "description" : "Add metadata.", "verbs":["POST"] } | [optional] |
| payment_terms | Integer | [optional] | |
| purchase_order | String | { "default": " ", "description":"Purchase order associated with the subscription. If specified this is copied to any invoices issued for this subscription.","verbs":["POST"]} | [optional] |
| contract_start | DateTime | {"description":"start of the contracted period. This will be after a trial, if one exists","verbs":["GET"]} | [optional] |
| 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] |
| prepayment_amount | Float | { "description":"How much prepayment should be taken upfront.", "verbs":["POST","GET"]} | [optional] |
This repository was archived by the owner on Oct 17, 2023. It is now read-only.