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 admin to collect additional details from the users during the checkout process. This section is located at Backend > PayPlans > Orders > Custom Details.

Below is an example of full set of XML code for available custom details(<field>) in 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 with an empty string instead of leaving it empty such as required="". Also the name attribute of the <fields> and <fieldset> must not be changed.

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

  • list --> class, required

  • country --> Same as 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


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

Custom Details

NOTE:
Custom Details for the subscriptions cannot be edited by the users after the checkout process.

Whenever the users fill up the custom details, they may see it in their subscription details as shown below for an example.

Custom Details

In the backend, custom details will appear in the subscription entries under the subscription listing, provided that custom details is enabled in the subscribed plans as shown below for an example.

Custom Details

IMPORTANT:
Any changes done to any custom details instance will immediately take effect on all related subscriptions, 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.