Plans

The plans tag outputs data related to available global subscription plans.

Parameters

limit

The number of plans to display. Defaults to 100.

plan_id

Filter to one or more plan IDs. Pipe-delimited values are supported.

plan_id="3|7|9"

sort

The plan field to order by. Defaults to id and sorts descending.

sort="id"

Variables

id

Plan ID

status

Outputs the current status of this subscription plan.

name

The descriptive name of the plan.

description

A description of the plan.

total_occurrences

The total number of occurrences that will be billed with this plan.

trial_occurrences

The total number of times the trial price should be billed switching to the standard price.

interval_length

This is the rebill periodicity. Generally this will be 1 (for once a month). By default it will be 1.

interval_units

This is the rebill period. Acceptable values are years, months, weeks, days. Defaults to “months” if not set.

allow_modification

Whether the customer should be allowed to update their subscription.

price

The formatted amount of the subscription plan.

trial_price

The formatted trial price of the subscription plan.

price_numeric

The numeric subscription amount.

trial_price_numeric

The numeric trial price.

price_per_day

Formatted per-day cost derived from price, interval_length, and interval_units.

member_has_plan

Integer boolean (1 or 0) indicating whether the logged-in member currently has a subscription on this plan.

{if no_results}

Rendered when no plans match your filter.

Example

{exp:cartthrob:plans plan_id="3|7" sort="id" limit="10"}
    {id}
    {name}
    {description}
    {total_occurrences}
    {allow_modification}
    {interval_units}
    {interval_length}
    {trial_occurrences}
    {price}
    {price_per_day}
    {member_has_plan}

    {if no_results}
        No plans are currently available.
    {/if}
{/exp:cartthrob:plans}