Subscriptions

Link copied to clipboard

This panel displays the list of subscriptions (assigned directly to this customer) that match your search query.

You can manage these subscriptions and assign more subscriptions to the customer.

Customer subscriptions

Specify one or more search criteria and click Search. To reset the search criteria, click Default filters Default filters.

Quick search options

Link copied to clipboard

Filter subscriptions by internal name and/or name for end users. By default, the search is performed only by internal name.

To include or exclude the search criteria, click Quick search options Matching mode and select/clear the checkboxes:

  • Name – the internal name of the subscription.
  • Name for end users – the name of the subscription visible to end users.

    Subscriptions - search options

By default, PortaBilling filters subscriptions by the name that starts with your input. You can filter the subscriptions with a name that:

  • Exactly matches – exactly matches your input.
  • Starts with – starts with your input.
  • Contains – contains your input (anywhere in the name).
  • Ends with – ends with your input.

Once the filtering options are selected, the changes are automatically saved and applied to the next searches.

Status

Link copied to clipboard

Filter subscriptions by their status:

  • Any – this shows all subscriptions assigned to the customer.
  • Pending – subscriptions that are not yet active and will be activated in the future.
  • Active – subscriptions that are currently active.
  • Closed – subscriptions that have already been closed.

Subscription list

Link copied to clipboard

Each subscription record has the following columns:

Actions

Link copied to clipboard

This column features two buttons:

  • Click Edit Edit icon to edit a subscription.
  • Click Delete Delete to remove a subscription. Note that you can remove only subscriptions that haven’t been activated yet (they have been assigned but are pending activation).

Status

Link copied to clipboard

The status of the assigned subscription:

  • Pending – subscriptions that are not yet active and will be activated in the future.
  • Active – currently active subscriptions (the customer is billed for these subscriptions).
  • Closed – subscriptions that have already been closed.

Name

Link copied to clipboard

This is the subscription name that isn’t shown to end users. Under the name, you can see the standard subscription fee per customer’s billing period.

Name for end users

Link copied to clipboard

The subscription name that end users will see on their self-care interface.

Current fee

Link copied to clipboard

The amount of money that is charged for the current billing period.

Next fee

Link copied to clipboard

The amount of money that will be charged for the next billing period.

Periodic fee adjustment

Link copied to clipboard

This shows whether you increase or reduce a recurring fee for this customer.

  • No adjustment – the standard subscription fee is applied. The default discount is set for the customer, but the discount doesn’t apply to this specific subscription.
  • Default customer discount – the default discount is applied to the subscription, e.g., “Discount 10% (default)”. A 100% discount means “free service”.
  • Discount – a fixed discount amount or a discount rate is applied to this specific subscription for a defined period, e.g., “Discount 15%”for 3 billing periods”.
  • Upcharge – a fixed amount or an upcharge rate is applied to this specific subscription to increase the subscription fee for a defined period, e.g., “Upcharge 8 USD from February 1 to April 30”.

Activation date

Link copied to clipboard

This shows the date when the subscription is activated. Note that subscription activation depends on subscription settings:

  • Subscriptions with the At the given start date activation become active at the start date that is set while assigning the subscription to the customer.
  • Subscriptions with the Upon the account’s first usage activation become active on either the start date that is set while assigning the subscription to the customer or at the account’s first usage date – whichever comes later.

Note that if an activation fee is defined for a subscription, it’s applied on the activation date.

Promotion ends

Link copied to clipboard

The end date of the promotional period. This period is set in the subscription settings. To add/remove this column, click Settings Settings on the title bar, click Customize columns, and select/clear the Promotion ends checkbox.

Billed to

Link copied to clipboard

The end date of the billing period to which the subscription applies.

Start date

Link copied to clipboard

The date when the subscription should be activated. This date is set when assigning the subscription to the customer.

Finish date

Link copied to clipboard

The closing date of the subscription.

How to set a default discount for all subscriptions used by the customer and their accounts

Link copied to clipboard

You can reduce the subscription periodic fees for a specific customer by providing them a discount that by default, will apply to all subscriptions assigned to the customer directly and the subscriptions assigned to their accounts (via the product or directly).

You can manually change/remove this default discount for a specific subscription when you assign a new subscription to the customer (or by editing an already assigned subscription).

Note that the 100% discount rate means “free service”.

To set a default discount for the customer:

  • Click Set default discount on the toolbar.
  • In the Set customer’s default discount dialog, specify the default discount rate for the customer’s (and their accounts’) subscriptions, e.g., 10.
  • When you change the default discount for the customer, e.g., from 10 to 15%, the new rate will automatically apply to all subscriptions with the Default customer discount option selected in the Periodic fee adjustment field.
  • Click Apply.

How to add a subscription

Link copied to clipboard

To assign another subscription directly to the customer:

  • Click + Subscription on the toolbar.
  • Fill in the information in the Add subscription dialog:

    Add subscription configuration

    • Name – select the subscription from the dropdown list.
    • Name visible to end users – type a clear subscription name that end users will see on their self-care interface.
    • Start date – choose a desired subscription activation date (by default, the current date is set). Click Calendar <icon> and set the date, or type it in the “yyyy-mm-dd” format (2022-09-07).
    • Finish date – choose a subscription closing date (the finish date is not set by default). Click Calendar and set the date, or type it in the “yyyy-mm-dd” format (2022-09-10).
    • Charging period – select the charging period if multi-month prepaid plans are configured for the subscription charged in advance, e.g., 6 months.
    • Current billing period fee – this shows the subscription periodic fee that is charged each billing period.
    • Periodic fee adjustment – you can choose whether to apply the default customer discount (if it’s set for the customer), a specific discount/upcharge, or to not adjust the periodic fee at all. The default option is Default customer discount. You can choose one of the following options:
      • No adjustment – the standard subscription fee will be applied (even if the default customer discount is set for the customer).
      • Default customer discount – a discount defined in the Set default discount dialog will be applied to the subscription fee, e.g., 10%. Note that a 100% discount means “free service”.
      • Discount – select this option if you want to set a specific discount for this subscription. Specify the fixed discount amount or discount rate in the corresponding field, e.g., “Discount 15%”. A 100% discount means “free service”. Also, specify the period during which the discount will be active using one of the following methods:
      • For specific periods, by specifying the start and end date for each period (e.g., from February 18 to May 18). The last period can be without an end date.
      • For a set number of billing periods (e.g., 6 months).
    • Upcharge – select this option if you want to apply an upcharge that increases the standard subscription fee. Specify a fixed amount or an upcharge rate in the corresponding field, e.g., “Upcharge 8 USD”. Also, specify the period during which the upcharge will be active using one of the following methods:
      • For specific periods, by specifying the start and end date for each period (e.g., from February 18 to May 18). The last period can be without an end date.
      • For a set number of billing periods (e.g., 6 months).
  • Click Save.

How to review and edit subscription details

Link copied to clipboard

You can edit only pending and active subscriptions. Click Edit Edit icon in the Actions column or the subscription name to edit it.

Edit subscription configuration

On the Edit subscription configuration panel, you can change:

  • The subscription plan name that is visible to end users (Name for end users field).
  • Set the subscription closing date (Finish date field) to cancel the subscription.
  • The Periodic fee adjustment option.
  • The charging period for the subscription that is charged in advance with configured prepaid plans.

On the Edit subscription configuration panel, the subscription name is also a link to the corresponding subscription page.

Customize panel

Link copied to clipboard

To customize the result list, click Settings edit. Adjust which columns to display, the row style, or reset the settings to the default ones.

  • Re-order the columns – drag-and-drop the column headers right or left to place the columns in the order you want.
  • Re-order the rows – click Arrow up (or down) next to the column header to re-sort the rows. For example, this panel displays subscriptions in alphabetical order. You can re-sort them in reverse order.
  • Change the default number of results globally – use the Rows per page dropdown list in the bottom-right corner to adjust the maximum number of rows displayed on the page.
Docs for
What's new
Admin manuals
Handbooks
UI help
Developers documentation