| 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] |
| metadata | DynamicMetadata | { "description" : "Add metadata.", "verbs":["POST"] } | [optional] |
| id | str | {"description":"ID uniquely identifying this rate plan.","verbs":["GET"]} | [optional] |
| crm_id | str | {"description":"Customer-relationship-management ID of the rate plan.","verbs":["GET","PUT","POST"]} | [optional] |
| product_id | str | {"description":"ID of the product to which this rate plan belongs. A product is essentially a collection of rate plans, and describes the service conferred to a customer upon subscription to any of said product's rate plans. The product serves also as a template from which its rate plans can infer default attributes.","verbs":["POST","GET"]} | |
| currency | str | {"description":"The currency of the product-rate-plan — as specified by a three-character ISO 4217 currency code (i.e. USD).","verbs":["POST","GET"]} | |
| tax_status | str | {"default":"inclusive","description":"The tax status of the product-rate-plan — either inclusive or exclusive.<br><span class=\"label label-default\">exclusive</span>pricing indicates that the cost of the Pricing Components do not include tax; when BillForward generates an Invoice, the tax will be calculated with this price as a base. <br>Tax-<span class=\"label label-default\">inclusive</span>pricing indicates that the Pricing components include Tax. BillForward will still calculate tax on each invoice. Tax will be calculated from the sales price.","verbs":["POST","PUT","GET"]} | |
| failed_payment_behaviour | str | {"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"]} | |
| duration | int | {"description":"Number of length-measures which constitute the rate plan's period. If left unspecified: the rate plan will use the same `duration` number as the Product to which it belongs.","verbs":["POST","GET"]} | [optional] |
| duration_period | str | {"description":"Measure describing the magnitude of the rate plan's period. If left unspecified: the rate plan will use the same `durationPeriod` magnitude as the Product to which it belongs.","verbs":["POST","GET"]} | |
| trial | int | {"default":0,"description":"Number of trial-length-measures which constitute the rate plan's trial period. If left unspecified: the rate plan will use the same `trial` number as the Product to which it belongs.","verbs":["POST","PUT","GET"]} | [optional] |
| trial_period | str | {"default":"none","description":"Measure describing the magnitude of the rate plan's trial period. If left unspecified: the rate plan will use the same `trialPeriod` magnitude as the Product to which it belongs.","verbs":["POST","PUT","GET"]} | [optional] |
| product_type | str | {"default":"recurring","description":"The frequency of the rate plan — either recurring or non-recurring. If left unspecified: the rate plan will use the same `productType` frequency as the Product to which it belongs.","verbs":["POST","PUT","GET"]} | [optional] |
| pro_rata_mode | str | {"default":"WithCoupon","description":"The pro-rata mode for the rate plan. <br><span class=\"label label-default\">None</span> — The pro-rata cost for upgrades will be ignored.<br><span class=\"label label-default\">WithCoupon</span> — The pro-rata cost for upgrades will be calculated based on the time remaining for the subscription. Discounts from any attached coupons will be deducted from the pro-rated cost.<br><span class=\"label label-default\">WithoutCoupon</span> — The pro-rata cost for upgrades will be calculated based on the time remaining for the subscription. Discounts from any attached coupons will not be deducted from the pro-rated cost. ","verbs":[]} | |
| create_zero_valued_invoices | bool | {"default":"true","description":"Whether invoices are created if they have a zero valued cost before any discounts are applied.","verbs":["POST","PUT","GET"] } | [default to False] |
| name | str | {"description":"A friendly name — for your benefit — used to identify this rate plan within some product in BillForward. The name should reflect the fact that this rate plan provides to the customer a price tiering system within which a subscription to its Product can be made. <br>The rate plan's name could describe the nature of its price tiering (e.g. \"Default pricing\", \"Student pricing\").<br>Remember also that rate plans can override the timing prescribed by their product. If your rate plan is defined by its overriding the default timing of its product, then that can be reflected in that rate plan's name. (e.g. \"Student pricing - Annual\").","verbs":["POST","PUT","GET"]} | |
| public_name | str | {"description":"A friendly non-unique name used to identify this product-rate-plan","verbs":["POST","PUT","GET"]} | [optional] |
| valid_from | datetime | {"description":"The UTC DateTime specifying when the rate plan is valid from.","verbs":["GET"]} | [optional] |
| valid_till | datetime | {"description":"The UTC DateTime specifying when the product-rate-plan is valid till.","verbs":["GET"]} | [optional] |
| status | str | {"description":"The current status of the rate plan.","verbs":[]} | [optional] |
| migration_behaviour | str | {"default":"CreditAccount","description":"The action that should be taken, should the pro-rata calculation result in a negative value.<br><span class=\"label label-default\">NoCharge</span> — Don't return to the customer any money.<br><span class=\"label label-default\">CreditAccount</span> — Credit the customer's account with the amount.","verbs":["POST","PUT","GET"]} | |
| invoice_issue_type | str | {"default":"<span class=\"label label-default\">Immediate</span>","description":"The strategy for how invoices for this plan will be issued.<br><span class=\"label label-default\">Immediate</span> — All generated invoices move immediately to the 'Unpaid' state — beginning the payment pursuit process.<br><span class=\"label label-default\">Delayed</span> — All generated invoices begin in the 'Pending' state. An 'Issue Invoice' amendment is scheduled (based on the rate plan's `issueDuration` and `issuePeriod`) that will move the invoice to the 'Unpaid' state (beginning the payment pursuit process) in accordance with the rate plan's issuance schedule.<br><span class=\"label label-default\">Manual</span> — All generated invoices sit in the 'Pending' state — they will not be issued to the customer unless explicit action is taken. This gives you an opportunity to review or recalculate the invoice."verbs":["POST","GET"]} | [optional] |
| issue_duration | int | {"description":"Number of issue-length-measures between issuance of invoices for this rate plan.""verbs":["POST","GET"]} | [optional] |
| issue_period | str | {"description":"Measure describing the magnitude of the invoice issuance period.","verbs":["POST","GET"]} | [optional] |
| taxation | list[MutableBillingEntity] | {"description":"A list linking taxation strategies to the rate plan.","verbs":["POST","GET","PUT"]} | [optional] |
| fixed_term_definitions | list[MutableBillingEntity] | {"description":"A list linking \"Fixed-Term Definitions\" to the rate plan.","verbs":["POST","PUT","GET"]} | [optional] |
| product | Product | {"description":"The product to which this rate plan belongs. A product is essentially a collection of rate plans, and describes the service conferred to a customer upon subscription to any of said product's rate plans. The product serves also as a template from which its rate plans can infer default attributes.","verbs":["POST","GET"]} | [optional] |
| pricing_components | list[PricingComponent] | {"description":"The pricing-components which describe the price tiering system of this rate plan. A product rate plan may have 1 or more pricing components. Each pricing component represents a different charge associated with the subscription. Pricing components are versioned.","verbs":["POST","PUT","GET"]} | |
| aggregating_components | list[AggregatingComponent] | {"default":"(empty list)","description":"List of AggregatingComponents — these describe pricing components whose prices should be recalculated upon invoice aggregation. For example: two subscriptions' individual consumptions may be neither of them 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] |
| payment_terms | int | [optional] |
This repository was archived by the owner on Oct 17, 2023. It is now read-only.