+813-444-3589+44 118 328 3220+49-231-976765-0 | Contact us

Subscription

This object contains information about the various subscriptions the shop has to offer. A subscription e.g. allows customer to access all products for a monthly fee. The object has the following attributes:

Variable name Object Description Note
id int Returns an internal numerical identifier for the given subscription. EF
initial_cancelation int Returns the cancelation period during the initial runtime in either days, month or years (see initial_cancelation_mode). EF
initial_cancelation_mode int

Describes how to interpret the initial_cancelation value. The following values are possible:

  • 1 Days
  • 2 Months
  • 3 Years
EF
initial_runtime int Specifies how long the initial runtime (for the cost of price_inital) is in either days, month or years (see initial_runtime_mode). If this value is less or equal to 0, there is no initial runtime and the subscription directly starts with the regular runtime. EF
initial_runtime_mode int

This denotes how to interpret initial_runtime value. The following values are possible:

  • 1 Days
  • 2 Months
  • 3 Years
EF
price_initial int The initial price for the subscription (valid for the initial_runtime). Use the money filter for formatting the price. EF
price_regular int The regular price for the subscription (valid after the initial runtime, during the regular runtime). Use the money filter for formatting the price. EF
regular_cancelation int Returns the cancelation period for the regular runtime in either days, months or years (see regular_cancelation_mode). EF
regular_cancelation_mode int

Describes how to interpret the regular_cancelation value. The following values are possible:

  • 1 Days
  • 2 Months
  • 3 Years
EF
regular_minimum_periods int This is the minimum number of periods (in month) before the subscriptions can be canceled. Afterwards the regular cancelation period will be effective. EF
regular_charge_interval int Returns the number of month per charing period. 12 for a full year 3 for a quarter year.  
Title string The name of the subscription (e.g. “Annual Subscription – One (1) Device”). EF

Note: This object is exclusive to FlickRocket. If you are using a theme orginating from Shopify and want to use this functionality, you need to add this.