API extensions

This section describes API extensions which the Subscriptions Module introduces to the system.

Classes

• Subscriptions - interface API class containing useful subscriptions functions.
• Subscriptions_Plan - represents a subscription plan.

Extensions in the Shop_OrderItem class

Subscriptions Module adds the following fields to the Shop_OrderItem class:

• x_subscription_plan - identifier of a subscription plan
• x_subscription_start_date - subscription start date
• x_subscription_end_date - subscription end date
• x_subscription_paused - indicates whether the subscription is cancelled. If there multiple invoices have been generated for same subscription and customer, LemonStand checks this field value only for the first (most early) order item.
• x_subscription_item_id - subscription item identifiers. This field matches for order items in different invoices, which correspond a same subscription product.
• x_subscription_sf_included - subscription setup fee amount included to the order item price

Extensions in the Shop_Product class

Subscriptions Module adds the following fields to the Shop_Product class:

• subscription_plan - refers to a Subscriptions_Plan object, which represents a subscription plan selected for the product.
• x_subscription_use_prod_price - indicated whether the subscriptions engine should use the product price in new subscription orders, or a value specified in the Subscription fee field (the x_subscription_fee model field).
• x_subscription_fee - specifies the subscription fee value entered manually on the Subscriptions tab of the Create/Edit Product form.
• x_subscription_setup_fee - subscription setup fee

Next: Subscriptions class
Previous: Implementation approaches
Return to Subscriptions module