Chapter 1. Liquid Reference

If a form of this model is rendered after an unsuccessful submit, this returns errors that occurred.

{{ account.errors.name | inline_errors }}

Returns the id of the account.

Returns the organization name of the developer’s account.

Returns a text about a vat zero.

Returns the vat rate.

Unread messages.

Returns the latest messages.

Returns the plan the account has contracted.

Returns the contract account.

Returns whether the account is required to enter credit card details.

Returns whether the account has credit card details stored.

Returns whether the account has no credit card details stored.

Returns timezone of this account.

Returns whether the account has at least a paid contract.

Returns whether the account is on trial period, i.e. all his paid contracts has to be in trial period.

Returns the telephone number of the account.

Returns whether the account requires approval?

Returns UNIX timestamp of account creation (signup). Example: Converting timestamp to JavaScript Date.

<script>
  var data = new Date({{ account.created_at }} * 1000);
</script>

Can be composed by legal address, city, and state.

Returns the applications of the account.

Returns a array with ServiceContract drops.

Returns the admin user of this account.

Returns the extra fields defined for the account as plain text.

Returns the fields defined for the account as plain text.

Returns only extra fields with values of this account. Example: Print all extra fields.

{% for field in account.extra_fields %}
  {{ field.label }}: {{ field.value }}
{% endfor %}

Returns all fields with values of this account. Example: Print all fields.

{% for field in account.fields %}
  {{ field.label }}: {{ field.value }}
{% endfor %}

Returns the billing address of this account.

Returns whether this account has a billing address or not.

Gives access to permission methods.

{% if account.can.be_deleted? %}
  <!-- do something -->
{% endif %}

Returns whether the plan is selected.

{% if plan.selected? %}
  <p>You will signup to {{ plan.name }}</p>
{% endif %}

Returns whether the plan is bought.

{% if plan.bought? %}
   <p>You are  on this plan already!</p>
{% endif %}

Returns an array of available features.

Returns the setup fee.

Returns the name of the plan.

<h2>We offer you a new {{ plan.name }} plan!</h2>

Returns the system name of the plan.

{% for plan in available_plans %}
  {% if plan.system_name == 'my_free_plan' %}

    <p>You will buy our only free plan!</p>
  {% endif %}
{% endfor %}

Returns the plan id.

The plan is free if it is not paid. See the paid? method.

{% if plan.free? %}
   <p>This plan is free of charge.</p>
{% else %}

     <p>Plan costs</p>
     Setup fee {{ plan.setup_fee }}
     Flat cost {{ plan.flat_cost }}

{% endif %}

The plan is paid when it has non-zero fixed or setup fee or there are some pricing rules present.

{% if plan.paid? %}
   <p>this plan is a paid one.</p>
{% else %}
   <p>this plan is a free one.</p>
{% endif %}

Returns whether the plan requires approval?

{% if plan.approval_required? %}
   <p>This plan requires approval.</p>
{% endif %}

Returns the monthly fixed fee of the plan.

The alert level can be one of 50, 80, 90, 100, 120, 150, 200, 300.

Text message describing the alert, for example hits per minute: 5 of 5.

Decimal number marking the actual utilization that triggered the alert 1.0 is equal to 100%.

Used by {{ alert.utilization | times: 100 }} percent.

If a form of this model is rendered after an unsuccessful submit, this returns errors that occurred.

{{ application.errors.name | inline_errors }}

Returns the id of the application.

Returns true if changing of the application is allowed, either directly or by request.

Returns true if the contract is still in the trial period.

Note: If you change the trial period length of a plan, it does not affect the existing contracts.

There are three possible states:

    - pending
    - live
    - suspended

Number of day still left in the trial period.

Returns a plan drop with the plan of the application.

Returns name of the allowed action

Returns a warning messenger of the allowed action.

Returns the admin_url of the application.

Returns the name of the application.

Returns true if application state is pending.

Returns the description of the application.

Returns the redirect URL for the OAuth of the application.

Returns the amount of referrer filters allowed for this application.

Returns the amount of application keys allowed for this application.

Returns the referrer filters associated with this application.

Returns the reason for rejecting an application.

Returns the user_key of application.

Returns the application_id of an application.

Returns the application id or the user key.

Returns URL of the builtin detail view for this application.

Returns URL of the builtin edit view for this application.

Service to which that application belongs to.

Returns the keys of an application.

{% case application.keys.size %}
{% when 0 %}
  Generate your application key.
{% when 1 %}
  <h4>Application key for {{ application.name }} {{ application.application_id }}</h4>
  <p>Key is: {{ application.keys.first }}</p>
{% else %}
  <h4>Application keys for {{ application.name }} {{ application.application_id }}</h4>
  <ul>
    {% for key in application.keys %}
      <li>{{ key }}</li>
    {% endfor %}
  </ul>
{% endcase %}

Returns non-hidden extra fields with values for this application. Example: Print all extra fields.

{% for field in application.extra_fields %}
  {{ field.label }}: {{ field.value }}
{% endfor %}

Returns all builtin and extra fields with values for this application. Example: Print all fields.

{% for field in application.fields %}
  {{ field.label }}: {{ field.value }}
{% endfor %}

Returns only builtin fields of the application.

Returns whether the plan is selected.

{% if plan.selected? %}
  <p>You will signup to {{ plan.name }}</p>
{% endif %}

Returns whether the plan is bought.

{% if plan.bought? %}
   <p>You are  on this plan already!</p>
{% endif %}

Returns the visible features of the plan.

{% if plan == my_free_plan %}
   <p>These plans are the same.</p>
{% else %}
   <p>These plans are not the same.</p>
{% endif %}

Returns the setup fee of the plan.

Returns the name of the plan.

<h2>We offer you a new {{ plan.name }} plan!</h2>

Returns the system name of the plan.

{% for plan in available_plans %}
  {% if plan.system_name == 'my_free_plan' %}

    <p>You will buy our only free plan!</p>
  {% endif %}
{% endfor %}

Returns the plan id.

The plan is free if it is not paid. See the paid? method.

{% if plan.free? %}
   <p>This plan is free of charge.</p>
{% else %}

     <p>Plan costs</p>
     Setup fee {{ plan.setup_fee }}
     Flat cost {{ plan.flat_cost }}

{% endif %}

The plan is paid when it has non-zero fixed or setup fee or there are some pricing rules present.

{% if plan.paid? %}
   <p>this plan is a paid one.</p>
{% else %}
   <p>this plan is a free one.</p>
{% endif %}

Returns whether the plan requires approval?

{% if plan.approval_required? %}
   <p>This plan requires approval.</p>
{% endif %}

Returns the monthly fixed fee of the plan.

Returns the metrics of the plan.

Returns the usage limits of the plan.

Returns the service of the plan.

If a form of this model is rendered after an unsuccessful submit, this returns errors that occurred.

{{ base.errors.name | inline_errors }}

Returns the title result.

Returns the kind of result, can be 'topic' or 'page'.

Returns the resource URL of the result.

Returns a descriptive string for the result.

If a form of this model is rendered after an unsuccessful submit, this returns errors that occurred.

{{ contract.errors.name | inline_errors }}

Returns the id

Returns true if any form of change is possible.

Returns true if the contract is still in the trial period.

There are three possible states:

    - pending
    - live
    - suspended

Number of day still left in the trial period.

Returns the plan of the contract.

Returns name of the allowed action

Returns a warning messenger of the allowed action.

If a form of this model is rendered after an unsuccessful submit, this returns errors that occurred.

{{ country.errors.name | inline_errors }}

Returns ID of the country.

{{ account.fields.country.value }} => 42

compare with:

{{ account.fields.country }} => 'United States'

Returns system name of the field.

Returns label of the field.

{{ account.fields.country.label }}
<!-- => 'Country' -->

Returns name of the country.

{{ account.fields.country }} => 'United States'

If a form of this model is rendered after an unsuccessful submit, this returns errors that occurred.

{{ current_user.errors.name | inline_errors }}

Returns whether the user is an admin.

{% if user.admin? %}
  <p>You are an admin of your account.</p>
{% endif %}

Returns the username of the user, html escaped.

Returns the account of the user.

Returns the first and surname of the user.

Returns the email of the user.

This method will return true for users using the builtin Developer Portal authentication mechanisms and false for those that are authenticated via Janrain, CAS or other single-sign-on method.

{{ if user.password_required? }}


{{ endif }}

Returns the list of sections the user has access to.

{% if user.sections.size > 0 %}
  <p>You can access following sections of our portal:</p>
   <ul>
    {% for section in user.sections %}
      <li>{{ section }}</li>
    {% endfor %}
  </ul>
{% endif %}

Returns the role of the user.

Retuns a list of available roles for the user

{% for role in user.roles_collection %}
  <li>
    <label for="user_role_{{ role.key }}">

      {{ role.text&nbsp;}}
    </label>
    </li>
  {% endfor %}

Return the resource URL of the user.

{{ 'Delete' | delete_button: user.url }}

Return the URL to edit the user.

{{ 'Edit' | link_to: user.edit_url, title: 'Edit', class: 'action edit' }}

Exposes rights of current user, which are dependent on your settings and user’s role. You can call these methods on the returned object:

{% if current_user.can.see_log_requests? and application.log_requests? %}
   (<a href="{{ application.log_requests_url }}" class="action edit">App Request Log</a>)
{% endif %}

Returns non-hidden extra fields with values for this user. Example: Print all extra fields.

{% for field in user.extra_fields %}
  {{ field.label }}: {{ field.value }}
{% endfor %}

Returns all fields with values for this user. Example: Print all fields.

{% for field in user.fields %}
  {{ field.label }}: {{ field.value }}
{% endfor %}

Returns all builtin fields with values for this user.

Returns attribute of the model to this error is related.

{{ account.errors.org_name.first.attribute }}
<!-- org_name -->

Returns description of the error.

{{ account.errors.first.message }}
<!-- cannot be blank -->

Returns value of the attribute to which the error is related.

{{ account.errors.org_name.first.value }}
 <!-- => "ACME Co." -->

Returns full description of the error (includes the attribute name).

{{ model.errors.first }}
<!-- => "Attribute can't be blank" -->

Returns true if there are no errors.

{% if form.errors == empty %}
  Congratulations! You have no errors!
{% endif %}

Returns true if there are some errors.

{% if form.errors == present %}
  Sorry, there were some errors.
{% endif %}

If a form of this model is rendered after an unsuccessful submit, this returns errors that occurred.

{{ feature.errors.name | inline_errors }}

Returns the name of the feature.

<h2>Feature {{ feature.name }}</h2>

Returns the description of the feature.

Returns whether the feature has description.

{% if feature.has_description? %}
  {{ feature.description }}
{% else %}
   This feature has no description.
{% endif %}

Returns value of the field.

Name: {{ account.fields.first_name.value }}

Returns system name of the field.

Returns name for the HTML input that is expected when the form is submitted.

<!-- the 'name' attribute will be 'account[country]' -->

Returns a unique field identifier that is commonly used as HTML ID attribute.

{{ account.fields.country.html_id }}
<!--  => 'account_country' -->

Returns label of the field.

{{ account.fields.country.label }}
<!-- => 'Country' -->

Returns value of the field if used as variable.

{{ account.fields.first_name }} => 'Tom'

Returns an array of choices available for that field, if any. For example for a field called fruit it may respond with ['apple', 'bannana', 'orange'].

You can define choices in the 3scale Admin Portal under Audience > Accounts > Settings > Fields Definitions. Each of the array elements responds to id and label which are usually just the same unless the field is a special builtin one (like country). It is recommended to use those methods rather than output the choice 'as is' for future compatibility.

{% for choice in field.choices %}
  <select name="{{ field.input_name }}" id="{{ field.html_id }}_id"
          class="{{ field.errors | error_class }}">
  <option {% if field.value == choice %} selected {% endif %} value="{{ choice.id }}">
    {{ choice }}
  </option>
{% endfor %}

Returns an array of messages.

{% for message in flash.messages %}
   <p id="flash-{{ message.type }}">
     {{ message.text }}
   </p>
{% endfor %}

Returns true if you have forum functionality enabled.

{% if forum.enabled? %}
  <a href="/forum">Check out our forum!</a>
{% endif %}

Alias for %b %d

Dec 11

Alias for %B %d, %Y

December 11, 2013

Alias for %Y-%m-%d

2013-12-11

If a form of this model is rendered after an unsuccessful submit, this returns errors that occurred.

{{ invitation.errors.name | inline_errors }}

Returns email address.

Returns true if the invitation was accepted.

Returns a date if the invitation was accepted.

{{ invitation.accepted_at | date: i18n.short_date }}

Returns the creation date.

{{ invitation.sent_at | date: i18n.short_date }}

Returns the URL for resend the invitation.

{{ "Resend" | update_button: invitation.resend_url}}

Returns the resource URL.

{{ "Delete" | delete_button: invitation.url }}

If a form of this model is rendered after an unsuccessful submit, this returns errors that occurred.

{{ invoice.errors.name | inline_errors }}

Returns a friendly id.

<td> {{ invoice.id }} </td>
<td> {{ invoice.name }} </td>
<td> {{ invoice.state }} </td>
<td> {{ invoice.cost }} {{ invoice.currency }} </td>

String composed by month and year.

Returns a number with two decimals.

23.00

Returns cost without VAT.

Returns vat amount.

Return true if the PDF was generated.

{{ invoice.period_begin | date: i18n.short_date }}

{{ invoice.period_end | date: i18n.long_date }}

{{ invoice.issued_on | date: i18n.long_date }}

{{ invoice.due_on | date: i18n.long_date }}

{{ invoice.paid_on | date: i18n.long_date }}

Return a AccountDrop.

Returns a array of LineItemDrop.

{% for line_item in invoice.line_items %}
  <tr class="line_item {% cycle 'odd', 'even' %}">
    <th>{{ line_item.name }}</th>
    <td>{{ line_item.description }}</td>
    <td>{{ line_item.quantity }}</td>
    <td>{{ line_item.cost }}</td>
  </tr>
{% endfor %}

Returns a array of PaymentTransactionDrop.

{% for payment_transaction in invoice.payment_transactions %}
  <tr>
    <td> {% if payment_transaction.success? %} Success {% else %} Failure {% endif %} </td>
    <td> {{ payment_transaction.created_at }} </td>
    <td> {{ payment_transaction.reference }} </td>
    <td> {{ payment_transaction.message }} </td>
    <td> {{ payment_transaction.amount }} {{ payment_transaction.currency }} </td>
  </tr>
{% endfor %}

Return the resource URL of the invoice.

{{ "Show" | link_to: invoice.url }}

Return the resource URL of the invoice PDF.

{{ "PDF" | link_to: invoice.pdf_url }}

If a form of this model is rendered after an unsuccessful submit, this returns errors that occurred.

{{ line_item.errors.name | inline_errors }}

{% for line_item in invoice.line_items %}
  <tr class="line_item {% cycle 'odd', 'even' %}">
    <th>{{ line_item.name }}</th>
    <td>{{ line_item.description }}</td>
    <td>{{ line_item.quantity }}</td>
    <td>{{ line_item.cost }}</td>
  </tr>
{% endfor %}

If a form of this model is rendered after an unsuccessful submit, this returns errors that occurred.

{{ message.errors.name | inline_errors }}

Returns the id of the message.

If the subject is not present, then either a truncated body or (no subject) string is returned.

Body of the message.

Returns the creation date.

{{ message.created_at | date: i18n.short_date }}

URL of the message detail, points either to inbox or outbox.

Either 'read' or 'unread'.

Returns the name of the sender.

Returns the name of the receiver.

The possible types of the messages are:

If a form of this model is rendered after an unsuccessful submit, this returns errors that occurred.

{{ metric.errors.name | inline_errors }}

Returns the unit of the metric.

This metric is measured in {{ metric.unit | pluralize }}

Returns the description of the metric.

Returns the name of the metric.

<h4>Metric {{ metric.name }}</h4>
<p>{{ metric.description }}</p>

Returns the system name of this metric.

<h4>Metric {{ metric.name }}</h4>
<p>{{ metric.system_name }}</p>

Returns the usage limits of the metric.

{% if metric.usage_limits.size > 0 %}
   <p>Usage limits of the metric</p>
   <ul>
     {% for usage_limit in metric.usage_limits %}
       <li>{{ usage_limit.period }} : {{ usage_limit.value }}</li>
     {% endfor %}
   </ul>
 {% else %}
   <p>This metric has no usage limits</p>
{% endif %}

Returns the pricing rules of the metric

{% if metric.pricing_rules.size > 0 %}
  <p>Pricing rules of the metric</p>
  <ul>
  {% for pricing_rule in metric.pricing_rules %}
    <li>{{ pricing_rule.cost_per_unit }}</li>
  {% endfor %}
  </ul>

{% else %}
  <p>This metric has no pricing rules</p>
{% endif %}

If a form of this model is rendered after an unsuccessful submit, this returns errors that occurred.

{{ page.errors.name | inline_errors }}

Returns the title of the page.

<title>{{ page.title }}</title>

Returns system name of the page

{% if page.system_name == 'my_page' %}
  {% include 'custom_header' %}
{% endif %}

If a form of this model is rendered after an unsuccessful submit, this returns errors that occurred.

{{ page.errors.name | inline_errors }}

Number of items on one full page.

  {% for part in pagination.parts %}
    {% if part.is_link %}
      {% case part.rel %}
      {% when 'previous' %}
        {% assign css_class = 'previous_page' %}
      {% when 'next' %}
        {% assign css_class = 'next_page' %}
      {% else %}
        {% assign css_class = '' %}
      {% endcase %}

      <a class="{{ css_class }}" rel="{{ part.rel}}" href="{{ part.url }}">{{ part.title }}</a>
    {% else %}
      {% case part.rel %}
      {% when 'current' %}
         <em class="current">{{ part.title }}</em>
      {% when 'gap' %}
         &#x2026;
      {% else %}
         {{ part.title }}
      {% endcase %}
    {% endif %}
  {% endfor %}


<!-- Outputs:
  ============================================

  <a class="previous_page" rel="prev" href="?page=7">&#x2190; Previous</a>
  <a rel="start" href="?page=1">1</a>
  <a href="?page=2">2</a>
  <a href="?page=3">3</a>
  <a href="?page=4">4</a>
  <a href="?page=5">5</a>
  <a href="?page=6">6</a>
  <a rel="prev" href="?page=7">7</a>
  <em class="current">8</em>
  <a rel="next" href="?page=9">9</a>
  <a href="?page=10">10</a>
  <a href="?page=11">11</a>
  <a href="?page=12">12</a>
  &#x2026;
  <a href="?page=267">267</a>
  <a href="?page=268">268</a>
  <a class="next_page" rel="next" href="?page=9">Next &#x2192;</a>

=======================================
-->

Number of the currently selected page.

Items skipped so far.

Total number of pages.

Total number of items in all pages together.

Number of the previous page or empty.

Number of the next page or empty.

Elements that help to render a user-friendly pagination. See the [[part-drop[part drop] for more information.

Returns whether current payment gateway is braintreepayments.com.

Returns whether current payment gateway is authorize.Net.

Returns the type of this payment gateway.

If a form of this model is rendered after an unsuccessful submit, this returns errors that occurred.

{{ payment_transaction.errors.name | inline_errors }}

Returns the currency.

{% for payment_transaction in invoice.payment_transactions %}
  <tr>
    <td> {% if payment_transaction.success? %} Success {% else %} Failure {% endif %} </td>
    <td> {{ payment_transaction.created_at }} </td>
    <td> {{ payment_transaction.reference }} </td>
    <td> {{ payment_transaction.message }} </td>
    <td> {{ payment_transaction.amount }} {{ payment_transaction.currency }} </td>
  </tr>
{% endfor %}

Returns the amount.

Returns the creation date.

Returns true if was success.

Returns the message of the transaction.

Returns the reference.

If a form of this model is rendered after an unsuccessful submit, this returns errors that occurred.

{{ plan_feature.errors.name | inline_errors }}

Returns the name of the feature.

<h2>Feature {{ feature.name }}</h2>

Returns the description of the feature.

Returns whether the feature has description.

{% if feature.has_description? %}
  {{ feature.description }}
{% else %}
   This feature has no description.
{% endif %}

If a form of this model is rendered after an unsuccessful submit, this returns errors that occurred.

{{ post.errors.name | inline_errors }}

Text of the post.

Every post belongs to a [[topic-drop[topic]

Date when this post created.

{{ post.created_at | date: i18n.short_date }}

The URL of this post within its topic.

If a form of this model is rendered after an unsuccessful submit, this returns errors that occurred.

{{ post.errors.name | inline_errors }}

Returns the cost per unit of the pricing rule. Example: Using pricing rule drop in liquid.

<h2>Pricing rule</h2>
Min value {{ pricing_rule.min }}
Max value {{ pricing_rule.max }}
Cost per unit {{ pricing_rule.cost_per_unit }}

Returns the minimum value of the pricing rule.

Returns the maximum value of the pricing rule.

Returns plan of pricing rule.

Returns the name of your organization.

Domain {{ provider.domain }}

{% if provider.multiple_applications_allowed? %}

     <p>Applications</p>
     <ul>
     {% for app in account.applications %}
       <li>{{ app.name }}</li>
     {% endfor %}
     </ul>

{% else %}
   Application {{ account.applications.first.name }}
{% endif %}

For general questions, contact us at {{ provider.support_email }},
for invoice or payment related questions, contact us at {{ provider.finance_support_email }}

Returns the payment gateway associated with your organization.

Domain of your Developer Portal.

Returns the timezone that you use. You can change your timezone in the Admin Portal. Select Dashboard > Account Settings. In the Overview page, scroll down to Account Details, click Edit and modify the Time Zone field.

Support email of the account.

Finance support email of the account.

Returns the telephone number of the account.

True if developers can have more separate applications with their own keys, stats, and so on. This depends on your 3scale plan.

{% if provider.multiple_applications_allowed? %}

     <p>Applications</p>
     <ul>
     {% for app in account.applications %}
       <li>{{ app.name }}</li>
     {% endfor %}
     </ul>

{% else %}
   Application {{ account.applications.first.name }}
{% endif %}

Return the logo URL

True if your 3scale plan allows you to manage multiple APIs as separate services.

{% if provider.multiple_services_allowed? %}
  {% for service in provider.services %}
     Service {{ service.name }} is available.
  {% endfor %}
{% endif %}

True if the developer accounts can have multiple logins associated with them. This depends on your 3scale plan and if its visibility has been turned on for your Developer Portal in the Admin Portal under Audience > Developer Portal > Feature Visibility.

{% if provider.multiple_users_allowed? %}
  <ul id="subsubmenu">
    <li>
       {{ 'Users' | link_to: urls.users }}
    </li>
    <li>
      {{ 'Sent invitations' | link_to: urls.invitations }}
    </li>
  </ul>
{% endif %}

Returns all published account plans.

<p>We offer following account plans:</p>
<ul>
{% for plan in model.account_plans %}
  <li>{{ plan.name }} </li>
{% endfor %}
</ul>

Returns all defined services.

<p>You can signup to any of our services!</p>
<ul>
{% for service in provider.services %}
  <li>{{ service.name }} <a href="/signup/service/{{ service.system_name }}">Signup!</a></li>
{% endfor %}

You can enable or disable signups in the 3scale Admin Portal under Audience > Accounts > Settings > Usage Rules.

You can enable or disable account management in the 3scale Admin Portal under Audience > Accounts > Settings > Usage Rules.

Returns the URI of the request.

Returns the host with port of the request.

Returns the host part of the request URL.

Returns the path part of the request URL.

{% if request.path == '/' %}
  Welcome on a landing page!
{% else %}
  This just an ordinary page.
{% endif %}

Returns internal name of the role, important for the system.

Return a descriptive text for the role.

If a form of this model is rendered after an unsuccessful submit, this returns errors that occurred.

{{ search.errors.name | inline_errors }}

Returns the searched string

<h3>{{ search.token }}</h3>
<p>found on {{ search.total_found }} {{ search.item | pluralize }} </p>
<dl>
  {% for result in search.results %}
    <dt>
       [ {{ result.kind | capitalize}} ]
      {{ result.title | link_to: result.url }}
    </dt>
    <dd>
      {{ result.description }}
    </dd>
  {% endfor %}
</dl>

Returns the number of matching elements.

Returns an array of results for queue search.

If a form of this model is rendered after an unsuccessful submit, this returns errors that occurred.

{{ service.errors.name | inline_errors }}

Returns the name of the service.

Returns the system name of the service.

{% case service.system_name %}
{% when 'api' %}
  API is our newest service!
{% when 'old' %}
  Unfortunately, we do not allow more signups to our old service.
{% endcase %}

Returns the description of the service.

Returns whether the service is subscribed.

{% if service.subscribed? %}
   <p>You already subscribed this service.</p>
{% endif %}

Returns a subscription(ServiceContract drop) if the currently logged in user is subscribed to this service, Nil otherwise.

{% if service.subscription %}
   Your applications for service {{ service.name }} are:
   {% for app in service.subscription.applications %}
     {{ app.name }}<br/>
   {% endfor %}
{% else %}
   <p>You are not subscribed to this.</p>
{% endif %}

Returns the published application plans of the service.

{% for service in model.services %}
  <h4>{{ service.name }} application plans:</h4>
  <dl>
  {% for application_plan in service.application_plans %}
    <dt>{{ application_plan.name }}</dt>
    <dd>{{ application_plan.system_name }}</dd>
  {% endfor %}
  </dl>
{% endfor %}

Returns the published service plans of the service.

<p>We offer following service plans:</p>
<dl>
{% for service in model.services %}
  {% for service_plan in service.service_plans %}
    <dt>{{ service_plan.name }}</dt>
    <dd>{{ service_plan.system_name }}</dd>
  {% endfor %}
{% endfor %}
</dl>

Returns the application plans of the service.

Returns the visible features of the service.

{% if service.features.size > 0 %}
  <p>{{ service.name }} has the following features:</p>
  <ul>
  {% for feature in service.features %}
    <li>{{ feature.name }}</li>
  {% endfor %}
  </ul>
{% else %}
  <p>Unfortunately, {{ service.name }} currently has no features.</p>
{% endif %}

Depending on the authentication mode set, returns either 'ID', 'API key' or 'Client ID' for OAuth authentication.

{{ service.application_key_name }}

Returns the metrics of the service.

<p>On {{ service.name }} we measure the following metrics:</p>
<ul>
{% for metric in service.metrics %}
  <li>{{ metric.name }}</li>
{% endfor %}
</ul>

Support email of the service.

If a form of this model is rendered after an unsuccessful submit, this returns errors that occurred.

{{ service_contract.errors.name | inline_errors }}

Returns true if any form of change is possible.

Returns true if the contract is still in the trial period.

There are three possible states:

    - pending
    - live
    - suspended

Number of day still left in the trial period.

Returns the plan of the contract.

Returns name of the allowed action.

Returns a warning messenger of the allowed action.

Exposes specific rights of the current user for that subscription.

{% if subscription.can.change_plan? %}
  ...
{% endif %}

Returns whether the plan is selected.

{% if plan.selected? %}
  <p>You will signup to {{ plan.name }}</p>
{% endif %}

Returns whether the plan is bought.

{% if plan.bought? %}
   <p>You are  on this plan already!</p>
{% endif %}

Returns the visible features of the plan.

{% if plan == my_free_plan %}
   <p>These plans are the same.</p>
{% else %}
   <p>These plans are not the same.</p>
{% endif %}

Returns the setup fee of the plan.

Returns the name of the plan.

<h2>We offer you a new {{ plan.name }} plan!</h2>

Returns the system name of the plan.

{% for plan in available_plans %}
  {% if plan.system_name == 'my_free_plan' %}

    <p>You will buy our only free plan!</p>
  {% endif %}
{% endfor %}

Returns the plan ID.

The plan is free if it is not paid. See the paid? method.

{% if plan.free? %}
   <p>This plan is free of charge.</p>
{% else %}

     <p>Plan costs</p>
     Setup fee {{ plan.setup_fee }}
     Flat cost {{ plan.flat_cost }}

{% endif %}

The plan is paid when it has non-zero fixed or setup fee or there are some pricing rules present.

{% if plan.paid? %}
   <p>this plan is a paid one.</p>
{% else %}
   <p>this plan is a free one.</p>
{% endif %}

Returns whether the plan requires approval?

{% if plan.approval_required? %}
   <p>This plan requires approval.</p>
{% endif %}

Returns the monthly fixed fee of the plan.

Example: Using service plan drop in liquid.

<p class="notice">The examples for plan drop apply here</p>
Service of this plan {{ plan.service.name }}

Returns current month (1-12).

Returns current day of the month (1-31).

Returns current year. Example: Create dynamic copyright.

©{{ today.year }}

Returns date of beginning of current month.

This month began on {{ today.beginning_of_month | date: '%A' }}

If a form of this model is rendered after an unsuccessful submit, this returns errors that occurred.

{{ topic.errors.name | inline_errors }}

If a form of this model is rendered after an unsuccessful submit, this returns errors that occurred.

{{ topic.errors.name | inline_errors }}

Name of the topic. Submitted when first post to the thread is posted.

True if the path of the current page is the same as the one for the URL, or it is a direct subpath of it, that is, extended by ID. For example, with {{ urls.outbox }} these will return true:

But not these:

See also '#active?', '#current?'.

True if the URL path is the same as of the current. Parameters and other components are not taken into account. See also #active?'.

{% assign url = urls.messages_inbox %}
<!-- => http://awesome.3scale.net/admin/messages/sent -->

<!-- Current page: http://awesome.3scale.net/admin/messages/sent?unread=1 -->
{{ url.current? }} => true

<!-- Current page: http://awesome.3scale.net/admin/messages -->
{{ url.current? }} => false

True if the current page is in the same menu structure as this URL. See also #current?.

{% assign url = urls.messages_inbox %}
<!-- => http://awesome.3scale.net/admin/messages/sent -->

<!-- Current page: http://awesome.3scale.net/admin/messages -->
{{ url.active? }} => true

<!-- Current page: http://awesome.3scale.net/admin/messages/trash -->
{{ url.active? }} => true

<!-- Current page: http://awesome.3scale.net/admin/stats -->
{{ url.active? }} => false

<a href="{{ urls.signup }}">signup here</a>
<a href="{{ urls.service_subscription }}">subscribe to a service here</a>

URL of a signup page. Accessible for all.

<a href="{{ urls.signup }}?{{ service_plan | param_filter }}&{{ app_plan | param_filter }}" >Signup Now!</a>

URL to which all the search requests should be sent.

<form action="{{ urls.search }}" method="get">


</form>

URL to a service subscription page. Only for logged-in users.

<a href="{{ urls.service_subscription }}?{{ service_plan | param_filter }}" >
  Subscribe to service {{ service.name }}
</a>

URL to a page that allows the developer to contact provider via the internal messaging system.

URL to the list of messages sent by a developer.

URL or Nil if user account management is disabled. Check Usage Rules in the 3scale Admin Portal under Audience > Accounts > Settings > Usage Rules.

A page with API key(s) and other authentication info. Differs depending on the authentication strategy.

Page to invite new users.

List of all the sent invitations.

URL to the list of received messages.

Returns the period of the usage limit.

Usually hits but can be any custom method.

Returns the value of the usage limit.

If a form of this model is rendered after an unsuccessful submit, this returns errors that occurred.

{{ user.errors.name | inline_errors }}

Returns whether the user is an admin.

{% if user.admin? %}
  <p>You are an admin of your account.</p>
{% endif %}

Returns the username of the user, html escaped.

Returns the account of the user.

Returns the first and surname of the user.

Returns the email of the user.

This method will return true for users using the builtin Developer Portal authentication mechanisms and false for those that are authenticated via Janrain, CAS or other single-sign-on method.

{% if user.password_required? %}


{% endif %}

Returns the list of sections the user has access to.

{% if user.sections.size > 0 %}
  <p>You can access following sections of our portal:</p>
   <ul>
    {% for section in user.sections %}
      <li>{{ section }}</li>
    {% endfor %}
  </ul>
{% endif %}

Returns the role of the user.

Retuns a list of available roles for the user.

{% for role in user.roles_collection %}
  <li>
    <label for="user_role_{{ role.key }}">

      {{ role.text&nbsp;}}
    </label>
    </li>
  {% endfor %}

Return the resource URL of the user.

{{ 'Delete' | delete_button: user.url }}

Return the URL to edit the user.

{{ 'Edit' | link_to: user.edit_url, title: 'Edit', class: 'action edit' }}

Give access to permission methods.

{% if user.can.be_managed? %}
  <!-- do something -->
{% endif %}

Returns non-hidden extra fields with values for this user. Example: Print all extra fields.

{% for field in user.extra_fields %}
  {{ field.label }}: {{ field.value }}
{% endfor %}

Returns all fields with values for this user. Example: Print all fields.

{% for field in user.fields %}
  {{ field.label }}: {{ field.value }}
{% endfor %}

Returns all builtin fields with values for this user.