Viewing the list of subscriptions

To view the list of subscriptions, go to Subscriptions (see Navigation).

image2022-12-14_16-26-2.png

The list of subscriptions includes the following columns:

  • ID — the unique identification number of a subscription.

  • Name — the subscription name.

  • Account — the account name.

  • Plan — the plan name.

  • SKU (Offer ID) — the SKU of a plan. By default, the column is not displayed.

  • Billing type — the billing type of a plan. By default, the column is not displayed.

  • Manager — the name of a personal manager.

  • Trial — the type of subscription:Yes — a subscription to a free trial period.No — a subscription to a paid commercial period.

  • Status — the subscription status.

    Subscription statuses
    • Ordered — a new subscription is ordered and waits for the activation.

    • Active — a subscription is used.

    • Delivered — a subscription with the Non-recurring Subscription billing type is used.

    • Graced — a customer did not pay for a subscription on time, and after the grace period, a subscription will be stopped.

    • Stopped — a subscription is temporarily stopped.

    • Deleted — a subscription is permanently deleted.

    • Installation failed (installation_failed — in the API methods) — an error occurred during the installation of the ordered service.

    • Activation failed (activation_failed) — an error occurred during the subscription activation process.

    • Renewing failed (renewal_failed) — an error occurred during the subscription renewal process.

    • Updating failed (updating_failed) — an error occurred during the resource update process.

    • Stopping failed (stopping_failed) — an error occurred during the subscription stopping process.

    • Deletion failed (deletion_failed) — an error occurred during the subscription deleting process.

    • Switching failed (switching_failed) — an error occurred during the subscription plan switching process.

    • Installing — the ordered service is installing.

    • Activating — a subscription is activating.

    • Renewing — a subscription is renewing.

    • Updating — a subscription resource is updating.

    • Stopping — a subscription is stopping.

    • Deleting — a subscription is deleting.

    • Switching — the plan of a subscription is switching.

    • Waiting for manual approve (waiting_for_manual_approve) — the operation with a subscription waits for approval by a manager (see Manual Operations) due to the stop subscription and delete subscription modes set in the account class of the account (see Creating an Account Class).

    • Blocked — a postpaid subscription is stopped due to an expired payment.

  • Payment model — one of the following models:Postpay — a customer pays after using a service.Prepay — a customer pays before using a service.

  • Created at — the date when a subscription is created. By default, the column is not displayed.

  • Start date — the activation date of a subscription.

  • Updated at — the date when a subscription is updated.

  • Expiration date — the last day of a subscription.

  • Renewal — the number of a linked renewal order or delayed switch plan order in the Waiting for provisioning or Provisioning status (if exists). By default, the column is not displayed.

  • Auto-renew — the autorenewal option status for a subscription. By default, the column is not displayed:

    • Yes — auto-renewal is on.

    • No — auto-renewal is off or not applied due to the billing type or endless subscription period.

  • Paid to — a date, depending on the billing type (see Prolonging a subscription), by default, the column is not displayed:

    • For a subscription with the Monthly ProlongationMonthly Commitment, or Monthly Calendar Commitment billing type — there is an order in the Completed status that covers a period up to the indicated date.

    • For a subscription with the Pay as you go billing type — the value is absent.

    • For a subscription with any other billing type — the date is set to the expiration date right after purchase.

  • Individual price — the subscription prices source:Yes — a subscription is ordered at the individual prices or at the individual markup specified by a manager (see Ordering a subscription at the individual prices and Ordering a subscription at the individual markup).No — a subscription is ordered at the plan prices (see Ordering a subscription at the plan prices).

  • Main resource — the name of a resource with the highest priority (see Plan Resources). If several resources have the highest priority, the name of the first resource is displayed using the following sorting rule: numbers, A to Z, А to Я. By default, the column is not displayed.

  • Amount of main resource — the total quantity of the main resource ordered in the subscription as the sum of the included and additional quantity of the resource. By default, the column is not displayed.

  • Current cost of main resource, unit/month — the monthly cost of the main resource per unit. By default, the column is not displayed.

  • Currency — the currency of the plan of a subscription. By default, the column is not displayed.

Report

 Regardless of the displayed columns, the subscription report includes the following columns with the keys in column titles:

  • id

  • name

  • account_id

  • account_name

  • plan_id

  • plan_name

  • plan_sku

  • billing_type

  • plan_class

  • trial

  • status

  • payment_model

  • postpay_payment_expiration_period

  • created_at

  • start_date

  • update_at

  • expiration_date

  • renewal

  • auto-renewal

  • auto_renewal_disabled

  • paid_to

  • main_resource

  • main_resource_quantity

  • net_cost — in separate columns, all types of net cost fees for the main resource, discount included

  • main_resource_fee

  • plan_currency

  • custom_price

  • manager_name

  • tenant_name (a custom attribute for the Account entity)

  • tenant_id (a custom attribute for the Account entity)