Subscription plans

A plan defines the billing conditions of a subscription, including its price, frequency, renewal type, and optionally a deferred start date for charging.

Creating a Subscription Plan

Plans are managed from the Subscriptions module in the Admin.

Note: Deferred start does not affect payment method validation. The card is tokenized when creating the subscription, even though the charge occurs later.

CapabilityDescription
Plan nameCommercial name identifying the plan (Premium Plan).
Plan descriptionOptional text detailing what the plan includes ("Unlimited access to premium content").
Group nameInternal grouping for similar plans (Premium, Basic, Annual). Useful for organization.
Plan codeUnique identifier for the plan in your system (PLAN-001).
Plan amountThe value charged in each billing cycle.
CurrencyDetermines the currency in which the plan is charged.
FrequencyBilling frequency (weekly, monthly, annual, every 2 months, and so on).
Auto-renewalDefines whether associated subscriptions renew when their period ends.
Deferred startAllows defining when the first charge will occur, without making immediate payment.
StatusActive: available to assign to new subscriptions. Pending: the plan cannot be assigned to new subscriptions.

Creating a Plan with Deferred Start

Step by step

  1. In the sidebar menu, go to **Subscriptions
  2. In Subscriptions, click Plans.
  3. Click Create plan.
  4. Complete the plan's general fields: name, description, amount, currency, frequency, and renewal.
  5. In the Deferred start section, enable the "Schedule billing start" toggle.
  6. Select how you want to define the billing start:
    • On a specific day of the month: the charge will occur on the same day every month, regardless of when the subscription was created.

Example: if you select day 10, and the user subscribes on October 3, the first charge will be on October 10.

  • X days after acquiring the plan: the charge will occur X days after the subscription is created.

    Example: if you choose 7 days and the subscription starts on October 5, the subscription start period will be October 12.

  1. Save the changes by clicking Save plan.

    The deferred start will be recorded and applied to all subscriptions created with this plan.

Considerations

  • If a plan has deferred start, no immediate charge is made, but the payment method is validated.
  • Only one deferred start mode can be configured per plan.
  • Plan editing is not supported.
  • Deferred start cannot be edited once the plan has active subscriptions.
  • Charges are automatically scheduled according to the selected configuration, without requiring manual actions or additional API calls.

Subscriptions

In this section you can manage your customers' subscriptions and access the details of each: plan, payment history, and actions such as pause, cancel, or reactivate.

💡

This functionality is useful for business models based on memberships, periodic top-ups, access to recurring services, or digital packages.

View Subscriptions

Access the Subscriptions tab within the module.

FieldDescription
Subscription IDUnique subscription identifier.
Customer emailEmail associated with the subscription.
Plan nameActive plan the user is subscribed to.
Amount per invoiceValue charged periodically for the subscription.
Subscription startDate the subscription was activated.
Last payment dateDate of the last billing attempt.
StatusCurrent status: Active, Cancelled, Expired, Pending.

You can filter subscriptions by customer email, creation date, or plan name.


Subscription Details

Click on any subscription in the list to access its detailed view.

SectionDescription
Customer dataBasic information: name, email, customer ID.
Subscription detailsCurrent status, key dates, associated plan, amount, and billing frequency.
TransactionsList of charges processed for that subscription. Includes transaction ID, date, amount, processor, and payment status.

Cancelling a Subscription

Step by step

  1. Go to the Subscriptions section in the sidebar menu.
  2. In the Subscriptions tab, search for the customer by email or ID.
  3. Click the action menu icon ··· and select View subscription.
  4. In the detail view, click the Actions button and select Cancel.
  5. A modal will open with the option to select a Cancellation policy. There are three options:
Cancellation policyDescription
Cancel immediatelyEnds the subscription right away.
Cancel at the end of the billing periodKeeps the subscription active until the current cycle ends. It cancels automatically at the end of the period.
Cancel on a specific dateAllows manually defining a future cancellation date. Until that date, the subscription remains active.
  1. If you choose the specific date option, select the day on the calendar.
  2. (Optional) Add a cancellation reason to maintain traceability.
  3. Click Confirm cancellation to execute the action.

Pausing a Subscription

Step by step

  1. In the subscription detail, click the Actions button and select Pause.
  2. A modal will appear where you can choose the Pause policy. There are three options:
Pause policyDescription
Pause immediatelySuspends the subscription right away. No further charges are generated until it is reactivated.
Pause at the end of the billing periodKeeps the subscription active until the end of the current cycle, then pauses it automatically.
Pause on a specific dateSchedules the pause for a future date. Until that day, the subscription remains active.
  1. If you choose the specific date option, select the day on the calendar.
  2. (Optional) Enter a pause reason if you want to record context.
  3. Click Confirm pause to apply the action.