Skip to main content

Access Plan

For loop type lifter_access_plan, here are the query parameters and fields.

Query parameters​

  • can_expire - Determine if the access plan has expiration settings, true/false
    Type: boolean

  • has_membership - If plan is associate to a membership, true/false
    Type: boolean

  • has_restrictions - Determine if the plan has availability restrictions, true/false
    Type: boolean

  • has_trial - Determine if the plan has a trial offer, true/false
    Type: boolean

  • is_available_to_user - Determine if the plan is available to a user based on configured availability restrictions, true/false
    Type: boolean

  • is_featured - Determine if the plan is marked as "featured", true/false
    Type: boolean

  • is_free - Determines if a plan is marked as free, true/false
    Type: boolean

  • is_on_sale - Determine if a plan is *currently* on sale, true/false
    Type: boolean

  • is_recurring - Determine if the Access Plan has recurring payments, true/false
    Type: boolean

  • is_visible - Determine if the plan is visible, true/false
    Type: boolean

  • product - Product ID or "current" for current product where the plan is assigned. Both Courses and Memberships are sellable and can be instantiated as a product
    Type: string

Fields​

  • access_expiration - Access expiration

  • checkout_url - Return the url to the checkout page for a given plan

  • enroll_text - Return the enroll text of a given plan

  • expiration_details - A sentence explaining plan expiration details

  • frequency - Return the frequecy of a given plan

  • has_availability_restrictions - If the plan has availability restrictions

  • has_free_checkout - If the free checkout process & interface should be used for this access plan

  • has_trial - If the plan has a trial offer

  • is_available_to_user - If the plan is available to a user based on configured availability restrictions

  • is_featured - If the plan is marked as "featured"

  • is_on_sale - If the plan is *currently* on sale, string "true"/"false"

  • is_recurring - If the plan has recurring payments

  • is_visible - If the plan is visible

  • price - Return the price of a given plan (with the currency)

  • price_number - Return the price of a given plan

  • price_sale - Return the price on sale of a given plan

  • product_id - Product ID where the plan is assigned. Both Courses and Memberships are sellable and can be instantiated as a product

  • sale_end - Date when the sale pricing ends

  • sale_start - Date when the sale pricing begins

  • schedule_details - A sentence explaining the plan's trial offer

  • sku - User-created plan identifier

  • visibility - Get the access plans visibility setting