| Name | Type | Description | Notes |
|---|---|---|---|
| created | datetime | { "description" : "The UTC DateTime when the object was created.", "verbs":[] } | [optional] |
| account_id | str | {"description":"ID of the BillForward Account who will own this aggregating subscription. You should ensure beforehand that the customer has had a BillForward Account created for them.","verbs":["POST"]} | |
| organization_id | str | {"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 | str | {"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. 'BusinessCorp subscriptions, care of Mr Business (mr@busy.com)').","verbs":["POST"]} | [optional] |
| description | str | {"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. 'Business signed up using BUSYGUYS coupon, at management trade show').","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] |
| state | str | {"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] |
| product_rate_plan | str | {"description":"ID of the rate plan to which the subscription will be subscribing. If omitted: it will be assumed you wish to create a new rate plan as part of this request — this subscription will subscribe to that newly-created rate plan.","verbs":["POST"]} | [optional] |
| duration | int | {"description":"[Required if and only if `productRatePlan` is omitted] Number of length-measures which constitute the rate plan's period.","verbs":["POST"]} | [optional] |
| duration_period | str | {"description":"[Required if and only if `productRatePlan` is omitted] Measure describing the magnitude of the rate plan's period.","verbs":["POST"]} | [optional] |
| product_type | str | {"description":"[Required if and only if `productRatePlan` is omitted] The frequency of the rate plan — either recurring or non-recurring.","verbs":["POST"]} | [optional] |
| aggregating_components | list[CreateAggregatingComponentRequest] | {"default":"(empty list)","description":"[Required if and only if `productRatePlan` is omitted] List of components whose prices should be recalculated upon invoice aggregation. For example: two subscriptions' individual consumptions may neither of them be large enough to achieve bulk buy discounts. When aggregated, though, the same two subscriptions' consumption may add up to a quantity which does merit a bulk buy discount within your tiering system.","verbs":["POST"]} | [optional] |
| aggregate_all_subscriptions_on_account | bool | {"default":false,"description":"Whether this 'aggregating subscription' should collect charges (starting now) from all other subscriptions (current and future) belonging to this BillForward Account.","verbs":["POST"]} | [optional] [default to False] |
| currency | str | {"description":"[Required if and only if `productRatePlan` is omitted] The currency of the product-rate-plan — as specified by a three-character ISO 4217 currency code (i.e. USD).","verbs":["POST"]} |
This repository was archived by the owner on Oct 17, 2023. It is now read-only.