Skip to main content

Order

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

Query parameters​

  • has_coupon - If a coupon was used - true/false.
    Type: boolean

  • has_discount - If there was a discount applied to this order via either a sale or a coupon - true/false.
    Type: boolean

  • has_sale - If the access plan was on sale during the purchase - true/false.
    Type: boolean

  • has_scheduled_payment - If there's a payment scheduled for the order - true/false.
    Type: boolean

  • has_trial - If the order has a trial - true/false.
    Type: boolean

  • has_trial_ended - If the trial period has ended for the order - true/false.
    Type: boolean

  • is_recurring - If the order is recurring or singular - true/false.
    Type: boolean

  • product - Product ID or "current" for current product where the order is assigned.
    Type: string

  • status -
    Type: string, array

  • user - User ID or "current" for current user.
    Type: string

Fields​

  • access_expiration_date - Determine the date when access will expire

  • access_status - Get the current status of a student's access - 'inactive', 'expired', 'active'

  • billing_address_1 - Billing address_1

  • billing_address_2 - Billing address_2

  • billing_city - Billing city

  • billing_country - Billing country

  • billing_cycle - Billing cycle

  • billing_email - Billing email

  • billing_first_name - Billing first name

  • billing_frequency - Billing frequency

  • billing_last_name - Billing last name

  • billing_period - Billing period

  • billing_phone - Billing phone

  • billing_state - Billing state

  • billing_zip - Billing zip

  • coupon_amount - Formatted coupon amount with a currency symbol or percentage

  • coupon_amount_regular - Order coupon amount

  • coupon_amount_trial - Order coupon trial amount

  • coupon_value_trial - Order coupon trial value

  • customer_name - Customer's full name

  • gateway - Payment gateway instance for the order's selected payment gateway

  • gateway_title - Payment gateway title

  • has_coupon - If a coupon was used - true/false

  • has_discount - If there was a discount applied to this order - true/false

  • has_sale - If the access plan was on sale during the purchase - true/false

  • has_scheduled_payment - If there's a payment scheduled for the order - true/false

  • has_trial - If the order has a trial - true/false

  • has_trial_ended - If the trial period has ended for the order - true/false

  • id - Order ID

  • initial_price - Initial payment amount due on checkout - value of "total" except when the product has a trial

  • is_recurring - If the order is recurring - true/false

  • last_transaction_date - Date of the last (most recent) transaction

  • next_payment_date - Due date of the next payment according to access plan terms

  • original_total - Order original total

  • plan_title - Access plan title

  • product_id - Order product id

  • product_link - Order product link

  • product_title - Order product title

  • sale_price - Order sale price

  • start_date - Date of the first initially successful transaction - if none found, uses the created date of the order

  • status - Order llms status

  • status_name - Order status name

  • total - Total

  • transactions - Order transactions list loop- 'id', 'status', 'status_name', 'date', 'refund_amount', 'amount', 'net_amount', 'gateway_source_description', 'pages'

  • trial_end_date - Date when a trial will end

  • trial_length - Trial length

  • trial_original_total - Trial original total

  • trial_period - Trial period

  • trial_total - Trial total

  • view_link - Link to view the order on the student dashboard