Zum Hauptinhalt springen

Documentation

IMPORTANT

This is the outdated SI-documentation which will be adapted soon. A huge part may be obsolete!

Custom Details

Custom Details allows the site admin to collect additional details from the users. You can ask for different details from users based on the plan. Those entered data by users are available at PayPlans > Users > (select user). It can be modified by the site admin in case of incorrect information entered by the users from the backend as well.

Below is the example of the full set of XML code for the available custom details(<fields>) in the PayPlans currently.

<config>
    <fields name="params">
        <fieldset name="params">
            <field name="address" type="textarea"
                placeholder="Shipping Adress"
                rows="4"
                cols="25"
                label="Shipping Adress"
                required="required"
                class="your-custom-class"
                readonly="readonly"
                disabled="disabled"
                maxlength="30"
            />

            <field name="checkbox" type="checkbox" class="your-custom-class" required="required" label="Where did you read the news from?">
                  <option value="website">Website</option>
                  <option value="newsletter">Newsletter</option>
                  <option value="ads">Online Advertisement</option>
            </field>

            <field name="genre" class="your-custom-class" type="radio" default="pop" label="Genre"> 
                <option value="pop">Pop</option>
                <option value="classic">Classic</option>
                <option value="jazz">Jazz</option>
            </field>

            // Default value is either 0 or 1 only
            <field name="show_billing" type="toggler" default="0" label="Display Billing Details" />

            <field name="country" type="country" class="your-custom-class" required="required" label="Your Home Country" />

            <field name="bio" type="text"
                placeholder="Tell a bit about yourself"
                label="Biography"
                required="required"
                class="your-custom-class"
                readonly="readonly"
                disabled="disabled"
                maxlength="30"
            />

            <field name="reference" type="list" class="your-custom-class" required="required" label="Reference">
                <option value="0">Website</option>
                <option value="1">Newsletter</option>
                <option value="2">Online Advertisement</option>
                <option value="3">TV Ad</option>
            </field>

            <field name="telephone" type="telephone"
                placeholder="e.g. 012-34-567"
                label="Your Phone Number"
                pattern="[0-9]{3}-[0-9]{2}-[0-9]{3}"
                required="required"
                class="your-custom-class"
                readonly="readonly"
                disabled="disabled"
                maxlength="30"
            />

            <field name="documents" type="file"
                label="Upload your documents"
                accept=".docx, image/png"
                capture=""
                multiple=""
                required="required"
                class="your-custom-class"
                readonly="readonly"
                disabled="disabled"
            />
        </fieldset>
    </fields>
</config>

NOTE:
If the attribute does not need to contain any value, just append it with an empty string instead of leaving it empty. Example required="". DO NOT change the name attribute of the <field name=""> and <fieldset name="">.

Below is a list of what attributes are allowed for each of the available fields in PayPlans currently:

  • list --> class, required

  • country --> Same as the list

  • checkbox --> required, class

  • radio --> default, class

  • radio --> default

  • text --> maxlength, required, placeholder, class, readonly, disabled

  • textarea --> cols, required, placeholder, class, readonly, disabled, maxlength, rows

  • telephone --> maxlength, required, placeholder, class, readonly, disabled, pattern

  • file --> required, class, readonly, disabled, accept, capture, multiple


Custom Details Configuration

Navigate to PayPlans > Settings > General > Users (tab) and turn on Allow Users to Edit Custom Details option.

Custom Details


Custom Details on the Frontend

Below shows an example of how they are presented on the checkout page.

Custom Details

Users can also view their custom details from the User's Preference section.

Custom Details

User's Custom Details

The user's custom details can be viewed from the user listing section; provided that custom details are enabled in the subscribed plans as shown below.

Custom Details

IMPORTANT:
Any changes done to any custom details instance will take effect immediately on all affected users, including previous ones.
Wir benutzen Cookies
Wir nutzen Cookies auf unserer Website. Einige von ihnen sind essenziell für den Betrieb der Seite, während andere uns helfen, diese Website und die Nutzererfahrung zu verbessern. Du kannst selbst enscheiden, ob du Cookies zulassen möchtest. Bitte beachte, dass bei Ablehnung womöglich nicht mehr alle Funktionalitäten zur Verfügung stehen.