The Billing Plan Object - Vindicia Subscribe — SaaS Knowledge Center

The Billing Plan object is the schedule and, optionally, pricing rules for a subscription; every Subscription must have a Billing Plan assigned.

Attributes

Name	Type	Description
object	string	Value is “BillingPlan”
id	string	A merchant-specified unique identifier. If not specified, this object can be identified by its vid.
vid	string	A Globally Unique Identifier (GUID) for this object. Assigned by Subscribe.
created	datetime	The date and time the plan was created. Read only.
description	string	A Merchant-specified description of this offering.
status	enum	Merchants may define whether they want to declare a plan as available to offer. Values can be `Active`, `Suspended`
tax_classification	string	The tax classification or code to be used with any plan-level charges.
br_tax_category	enum	Enum used for Brazilian tax calculations. Values can be `Goods`, `Services`
trial	Billing Plan Period	Optionally declares an initial trial period for this plan.
periods	Billing Plan Period	Defines the sequential billing periods in the plan, each with its own billing schedule and terms.
billing_notification_days	integer	Number of days prior to schedule billing at which Subscribe will send a notification.
trial_end_notification_days	integer	For the trial period, this replaces billing_notification_days, indicating the # of days prior to end of a trial to send the trial end email.
skip_initial_billing_notification	boolean	Determines whether to send a billing notification for the initial period.
end_of_life	datetime	The date after which the plan should not be offered.
metadata	hash	A set of key/value pairs that you can attach to an object. Useful for storing additional information. For more details, see Metadata.
entitlements	Entitlement	Entitlements granted by active subscriptions on this plan.
billing_descriptor	string	Optional “soft descriptor” to send to the payment processor for transactions associated with a subscription using this billing plan.
grace_period_override	integer	Number of days after the billing date when, if payment is not received, the Subscription is stopped and the customer is disentitled; overrides the global merchant default setting, if both are set.
minimum_commitment	integer	Number of billing cycles the customer is contractually obligated to complete before cancelling. The only impact this has is upon the cancelling a Subscription.
cancel_fees	Billing Plan Cancel Fee	List of early cancel fees for various currencies.
times_to_run	string	The number of times the sequence of Billing Periods should be repeated. Valid input includes positive integers. (Default is null.) Advanced Setting
entitlements_valid_for	string	The length of time for which Entitlements are valid after the last Billing date. (Default is null.) Advanced Setting
repeat_every	string	If a Billing Period set repeats, this value defines the length of time after the first billing that the set should repeat. Advanced Setting
season_set	Season Set	The SeasonSet to which the Billing Plan applies. (May be null.)
days_before_season_to_bill	integer	Optional setting when using a season set to control the integer number of days before a season starts to bill. Advanced Setting
days_entitled_before_season	integer	Optional setting when using a season set to control the integer number of days customer is entitled before a season starts. Advanced Setting
days_entitled_after_season	integer	Optional setting when using a season set to control the integer number of days after a season ends a customer remains entitled. Advanced Setting
entitled_off_season	boolean	Optional setting when using a season set to continue entitling customer between seasons. Advanced Setting
used_on_subscriptions	boolean	Signifies if Billing Plan has been used on an Active Subscription. Read Only

Example Billing Plan Object

{
   "object":"BillingPlan",
   "id":"plan_1234",
   "vid":"1d557e85e70a13140dcc9bd4fd18a02f63f09084",
   "created":"2020-05-27T14:42:08-07:00",
   "description":"Simple Monthly Billing Plan",
   "status":"Active",
   "periods":{
      "object":"List",
      "data":[
         {
            "object":"BillingPlanPeriod",
            "type":"Month",
            "quantity":1,
            "cycles":0,
            "prices":{
               "object":"List",
               "data":[
                  {
                     "object":"BillingPlanPrice",
                     "amount":0,
                     "currency":"USD"
                  }
               ],
               "total_count":1
            }
         }
      ],
      "total_count":1
   },
   "end_of_life":"2099-12-31T00:00:00-08:00",
   "metadata":{
      "CatalogID":"plan1234"
   },
   "entitlements":{
      "object":"List",
      "data":[
         {
            "object":"Entitlement",
            "id":"plan_1234",
            "description":"plan_1234"
         }
      ],
      "total_count":1
   }
}

Parent topic:Billing Plans