In Fusebill, a plan is the template used to generate subscriptions. It specifies available products as well as the defaults for inclusion, charge timing, quantity, pricing, custom fields, and other configurations. Plans also configure the frequencies for subscriptions of different monthly and annual intervals.
Plan Object Fields
| Property | Type | Description |
|---|---|---|
code | String | The code of this plan. Fusebill enforces uniqueness of this value. [Max Length: 255 characters] |
name | String | The name of the plan. Can be overwritten on subscriptions made from this plan. [Max Length: 100 characters] |
reference | String | Called 'Reporting Reference' in the UI. [Max Length: 255 characters] |
description | String | The description of this plan. [Max Length: 1000 characters] |
longdescription | String | Called 'Notes' in the UI. [Max Length: 4000 characters] |
status | Enum: {Active, Retired} | Only active plans can be used to make subscriptions |
modificationTimestamp | DateTime | The timestamp of the last time this plan was modified. |
planFrequencies | List of objects. Defined below | Plans have one or more defined frequencies that are used to create subscriptions |
salesforceCompatible | Boolean | True if this plan can be used with a Salesforce integration |
id | Integer | The Fusebill generated ID that uniquely identifies this plan [Read Only] |
uri | String | The full string path to this resource [Read Only] |
Plan Frequency Fields
| Property | Type | Description |
|---|---|---|
planRevisionId | Integer | This is the unique identifier for this plan revision [Read Only] |
numberOfIntervals | Integer | This is the number of intervals that define a period |
interval | Enum:{Yearly, Monthly} | The unit of measurement used for defining billing periods |
numberOfSubscriptions | Integer | This is the number of instances of this plan currently in the system as subscriptions [Read Only] |
status | Enum: {Draft, Active, Retired} | Indicates the status of the plan this subscription was sourced from. |
isProrated | Boolean | This indicates if the subscription should prorate its charges if activated in the middle of a billing cycle. [Read Only] |
prorationGranularity | Enum:{Monthly, Daily} | This defines how granular the proration calculations are |
planFrequencyUniqueId | Integer | This is an internal identifier. [Read Only] |
customFields | Object. See Catalog: Custom Fields Object for definition. | The only difference is that the field defaultValue is present instead of Value. |
remainingInterval | Integer | The number of intervals after which subscriptions made from this plan will expire unless overridden. |
salesforceId | String | The ID of the Salesforce price book this Plan Frequency is associated with in Salesforce. Populated only if the Salesforce plugin is being used. |
id | Integer | The Fusebill generated ID that uniquely identifies this plan frequency. [Read Only] |