Skip to main content

Coupon

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

Query parameters​

  • access_plan - Access Plan ID or "current" for current access plan where the coupon is assigned.
    Type: string

  • has_main_discount - Determine if the main (non-trial) price is discounted by the coupon. true/false
    Type: boolean

  • has_remaining_uses - Determine if a coupon has uses remaining. true/false
    Type: boolean

  • has_trial_discount - Determine if trial amount discount is enabled for the coupon. true/false
    Type: boolean

  • is_expired - Determine if a coupon is expired. true/false
    Type: boolean

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

Fields​

  • amount - Get coupon amount

  • courses - Coupon courses sub Loop

  • expiration_time - The timestamp of a coupon expiration date

  • formatted_amount - Get the formatted coupon amount with currency symbol and/or percentage symbol

  • formatted_discount_type - Get the discount type for human reading and allow translation

  • has_main_discount - If the main (non-trial) price is discounted by this coupon,"true"/"false"

  • has_remaining_uses - If a coupon has uses remaining,"true"/"false"

  • has_trial_discount - If trial amount discount is enabled for the coupon,"true"/"false"

  • id - Coupon ID

  • is_expired - If a coupon is expired,"true"/"false"

  • memberships - Coupon memberships sub Loop

  • remaining_uses - The number of remaining uses

  • usage_limit - Coupon usage limit

  • uses - The number of times the coupon has been used