Subsbase Tech Glossary

This Tech Glossary serves as a quick reference guide, introducing users to business and technology terms associated with Subsbase.

Management Portal

TermDefinition
Active IntegrationsList of integrations currently active in the organization, available for use on the organization's site(s).
Active Payment MethodsList of payment methods currently active in the organization, available for use on the organization's site(s).
Admin UsersUsers with full or limited access to manage and configure the site, selected or invited during site creation.
Available IntegrationsList of all integrations offered/supported by Subsbase, from which admins can activate integrations based on plan limitations.
Available Payment MethodsList of all payment methods offered/supported by Subsbase, grouped by payment providers, for admins to activate for their organization.
Full ControlAccess level granting users the same privileges as the owner, including editing, deleting, revoking, and granting access to others.
Invite UsersThe action of sending invitations to users to join the organization within the Management Portal.
Live SitesSites that have been configured and activated for production use after testing in the test environment.
Management PortalA self-serve platform within Subsbase that allows users to manage subscriptions, create test sites, add users, integrations, and payment methods.
Multi-Language SupportFeature allowing users to switch between languages in the Management Portal.
NotificationsThe notification center in the Management Portal for receiving updates and important information about portal access and events.
OrganizationRepresents the user's entity within Subsbase, where they can manage settings, users, integrations, and payment methods.
OwnerThe user who checked out a plan and completed the Management Portal registration process, having full control of the organization.
Payment MethodsMethods through which customers can make payments, chosen by the admin from the available list.
Payment ProvidersService providers chosen to handle payments on the site, which can be added during or after site creation.
SettingsThe centralized page within the Management Portal for managing information related to subscriptions, payment history, payment schedules, and more.
Site Creation ConfirmationNotification indicating successful creation of a new site, sent via Management Portal and email with access details.
Site CurrenciesCurrencies selected for reporting and invoicing purposes on the site, compatible with chosen payment providers.
Site IDA sub-domain-friendly name for a site, using lowercase letters, numbers, and hyphens (-) as separators.
Site IndustryThe industry classification chosen during site creation to tailor services to specific business needs.
Test SitesSites created as pre-live simulation environments for testing configurations before going live.
UserA person invited to the organization with either full-control or view-only access, depending on their assigned privileges.
View OnlyAccess level limiting users to viewing the list of sites they are assigned to, without editing or managerial capabilities.

Admin Portal

Customers

TermDefinition
Add PlanThe process of adding a new plan to a customer's subscription.
Available BalanceThe current amount of money in the customer's account.
Bulk AddThe action of selecting multiple customers and adding them to a specific plan in bulk.
Bulk ChangeThe action of selecting multiple customers within a specific plan and applying a bulk change action to them.
Change PlanThe process of changing a customer's current plan to a different plan.
Customer ProfilesDetailed information about individual customers, including their balance, transactions, invoices, and subscription status.
CustomersIndividuals or entities who have subscribed to your plans and are tracked within the Subsbase platform.
Manual Usage EntryThe ability for admins to manually add or delete usage data within a billing cycle.
Payment MethodsThe payment methods associated with the customer's profile.
SubscriptionA subscription is used for modeling the bundle of items subscribed to by a customer.
Subscription StatusThe current state of a subscription, indicating whether it's active, canceled, in trial, changing, etc.
SurchargeAn extra fee within a billing cycle that covers specific costs or expenses associated with services or products.
TaxesAdditional charges imposed on services or products, often related to government regulations.
Usage QueryThe process of retrieving usage data for a specific billing cycle.

Invoicing

TermDefinition
AttachmentsFiles attached to an invoice, supporting documents or additional information related to the transaction.
Auto-Generated InvoiceAn invoice that is automatically generated by Subsbase based on specific triggers like new subscriptions, updates to existing subscriptions, or future renewal billing.
Draft InvoiceAn invoice that is in draft mode and can be freely edited until validated.
Invoice NarrativeAdditional text or messages included in invoices, such as headers, comments, and footers.
Invoice StatusesThe current state of an invoice, indicating whether it's open, overdue, paid, partially paid, processing, refunded, void, or voiding.
InvoicesDocuments that detail transactions between you and your customers, including the services provided, costs, and payment status.
Manage DiscountThe action of managing and applying discounts to invoices.
Manually Created InvoiceAn invoice that is created manually by an admin and requires validation before becoming an "Open" invoice.
Mark as PaidThe action of marking an invoice as paid, indicating that the payment has been made.
Request PaymentThe action of charging the invoice amount using the customer's default payment method.
Send Payment LinkThe action of sending an email with the invoice payment link to the customer.
Validate InvoiceThe action of validating a draft invoice to transition it into an "Open" invoice.

Transactions

TermDefinition
TransactionsRecords of payment-related operations on invoices, including authorization, capture, refund, failure, and pending statuses.
Transaction StatusesThe current state of a transaction, indicating whether it's authorized, captured, failed, pending, or refunded.
Transaction IdA unique identifier for each transaction.
Payment Gateway Ref. NumberA reference number provided by the payment gateway for tracking purposes.

Coupons

TermDefinition
Code (Prefix)Unique identifier for a coupon, case-sensitive.
Coupon AccountingApplication of coupons to the next invoice after redemption, with details on discounts, taxes, and fees.
Coupon InfoDetails required to create a coupon, including Name (Coupon Name), Code (Prefix), Type, Value, and Quantity.
Coupon RulesStart/End Date, Redemption Limit, and Plan Code settings defining coupon validity, usage limits, and applicable plans.
Coupon SettingsEdit and Delete options for managing coupons, with restrictions on editable attributes after creation.
CouponsCodes created to provide discounts to customers on subscriptions.
Name (Coupon Name)Internal name for a coupon campaign, not shown to customers.
QuantityNumber of coupon codes created in a campaign.
TypeTwo types of discounts: fixed amount and percentage.
Usage RulesUsage Limit setting indicating how many times a coupon is used for renewals.
ValueAmount or percentage of discount applied.

Plans

TermDefinition
AddonDefines a service or item that's being offered in addition to the plan on a recurring or non-recurring basis.
Billing ModelDefines how customers are charged for products or services: Prepaid or Postpaid.
DunningAutomated process for handling failed payments and retries.
PlanDefines a set of features for your product/service, the frequency of billing and amount to be charged for it on a recurring basis.
Pricing ModelDetermines the pricing structure for plans: Free, Fixed, Per Unit, Tiered, Volume, Stair Step.
Setup CostOne-time transaction charged at the beginning of a subscription billing cycle.
Term LimitSpecifies if the subscription will be automatically renewed or canceled after a certain period.
Trial SettingsProvides customers with a customizable trial period before the paid subscription begins.
Usage QueryMethod to collect data for usage calculations, either Manual, Automatic, or Both.

Schedules

TermDefinition
AttachmentsFiles attached to a payment schedule for additional information.
Batch AddEfficient creation of multiple repetitive scheduled payments.
CurrencyThe currency in which payments are processed for the payment schedule.
Dunning ProfilesProfiles used to recover failed payments, including existing ones or creating new profiles.
InvoicingOptions for generating invoices, including No Invoicing, Collective Invoice, and Per Payment Invoice.
Payment MethodThe method chosen for processing payments, including existing methods or creating new ones.
Payment ScheduleA customized billing frequency and payment plan for customers, including billing dates and amounts.
ProductRefers to the product or service associated with the payment schedule.
Schedule NameThe name given to a payment schedule for identification purposes.
Schedule RulesRules governing the payment schedule, excluding the customer and payment method fields.
Scheduled PaymentsPayments scheduled according to the payment schedule, with different statuses based on their progress.
Use TemplateCreating scheduled payments based on pre-made templates.

One-Time Payments

TermDefinition
One-Time PaymentsOne-Time Payments offer a convenient way to bill customers for non-recurring purchases, including immediate purchases or cases where a customer is not associated with a specific plan subscription.
On-Session PaymentOn-session payment refers to a payment processing flow where the customer's card information is not stored or tokenized for future use, used only for the specific transaction.

Customer Portal

TermDefinition
Customer PortalA platform within Subsbase that stores and manages all customer/subscriber details, including subscriptions, payment history, payment schedules, payment methods, and contact information.
Embedding Customer Portal via APIIntegrating the Customer Portal into your site or application using Subsbase's API.
Multi-Factor Authentication (MFA)An additional security measure that requires customers to enter a One-Time Password (OTP) during login, enhancing account security.
OTP (One-Time Password)A temporary password sent to customers via email during the login process for Multi-Factor Authentication.
Single Sign-On (SSO)A method for providing seamless access to the Customer Portal through integration with Subsbase's API.
SubscriptionsServices or products that customers are subscribed to, which can be viewed, added, changed, or canceled through the Customer Portal.
Theme SettingsConfiguration options for customizing the appearance and branding of the Customer Portal, accessible in the Admin Portal.

Integration

Embedding Checkout

TermDefinition
Attach PlanIntegrating subscription plans into clickable elements on your website, allowing customers to select plans directly from these elements.
CallbackAn optional action triggered after a specific event, such as signup completion, allowing communication with your backend or performing redirections.
Checkout VersionThe version of the checkout experience you want to use, such as Checkout Version 2 (v2), offering different features or improvements compared to the default version (Version 1).
Customer IdentifiersPre-setting customer identifiers (customerId) to match existing info in your system or follow a certain convention, ensuring accurate customer identification and data management during checkout.
Embedding CheckoutIntegrating Subsbase's checkout experience into your website using an integration script to provide a seamless payment process for customers without redirection.
Embedding OptionsCustomizable operations within the embedding script to configure various aspects of the checkout experience, such as initializing the site ID, customizing the theme, adding callbacks, specifying checkout version, attaching plans to clickable elements or inline containers, setting redirections, pre-filling info fields and custom fields, allowing geolocation, and setting customer identifiers.
GeolocationAllowing access to the user's geolocation information within the checkout experience, if required for specific functionalities.
Inline PlanIntegrating subscription plans inline within container elements on your website, providing a seamless checkout experience within your page.
Integration ScriptA script provided by Subsbase that enables the seamless integration of the checkout experience into your website, facilitating secure and efficient payment processing for customers.
Pre-filling Info FieldsPre-filling information fields in the checkout experience with predefined values or attaching custom fields visible in the Subsbase Admin Portal to checking out clients.
Query ParamA parameter used in the embedding script to specify various configurations, such as redirects, pre-filling fields, disabling info fields, and setting customer identifiers, among others, providing flexibility and customization options for the checkout experience.
Redirection after Successful PaymentAutomatically redirecting users to your website after a successful payment, improving user flow and completing the checkout process.
Redirection for Successful CheckoutAutomatically redirecting users to your website after a successful checkout process, enhancing user experience and completing the transaction flow.
Site IdA unique identifier representing your Subsbase site, required for initializing the embedding script to link your plans and configurations to the checkout experience on your website.
Theme CustomizationCustomizing the primary color used in the checkout experience to match your branding, enhancing the visual appeal of the checkout process for customers.

Embedding Plan Picker

TermDefinition
Attach Plan PickerThe operation to create and display a button on the web page, attaching the Plan Picker to it upon click, allowing customers to view and select subscription plans.
Configuration ObjectProperties used to configure both the Plan Picker button and the Plan Picker itself, including text, shape, icon, colors, positioning, alignment, visibility on mobile devices, delays, and settings related to grouping, display, expansion, collapsibility, sorting, and default sorting of plans in the Plan Picker.
Default Configuration ObjectThe default settings for the Plan Picker button and the Plan Picker itself, including default text, shape, icon, colors, positioning, alignment, visibility, delays, and default configuration of plan grouping, display, expansion, collapsibility, sorting, and default sorting order of plans.
Embedding OptionsCustomizable operations within the embedding script to configure the Plan Picker button and the Plan Picker itself, including text, shape, icon, colors, positioning, alignment, visibility on mobile devices, delay settings, and configuration of the Plan Picker.
Embedding Plan PickerIntegrating Subsbase's Plan Picker on your website using an integration script to allow customers to select subscription plans easily.
Hide Plan Picker on Mobile DevicesA flag or boolean value (true or false) used to specify whether to hide the Plan Picker on mobile devices, providing flexibility in displaying the Plan Picker based on the device screen size and user experience considerations.
Initializing the SiteIdA required operation to initialize the embedding script by specifying the "Site Id" associated with your Subsbase account, which contains the plans you want to attach to the Plan Picker.
Mobile ConfigurationAdditional configuration specific to mobile devices, used when the screen width is lower than 1024px, allowing customization of the Plan Picker's appearance and behavior on smaller screens.

Embedding Customer Portal

TermDefinition
Container ElementThe HTML element where the iframe is injected, and the iframe will fill the entire container based on the specified width and height.
Customer Portal URLThe URL of your Subsbase Customer Portal, provided by Subsbase within the Admin Portal under Settings > Customer Portal Settings > Site URL.
Customer Portal VersionThe version of the Customer Portal (e.g., Version 1 or Version 2) that you want to use for embedding.
Customer TokenA token specific to each customer, used for embedding the Customer Portal on a per-customer basis.
Default ConfigurationThe default settings for the embedded Customer Portal, including the default URL, token parameters, page visibility, and dimensions of the iframe.
Embedding Customer PortalIntegrating Subsbase's Customer Portal inside your website or web application through the use of an iframe, allowing customers to manage their subscriptions, payment methods, profile, and other related actions without leaving your platform.
iframeAn HTML element used to embed content from another website or web application within your own.
Server TokenA secure token obtained from Subsbase that grants access to your Subsbase account's functionality. It should not be exposed to the front-end as it provides full access to your account.
Show/HideOptional parameters used to specify whether to show or hide specific pages in the embedded Customer Portal, such as 'subscriptions', 'paymentmethods', 'paymenthistory', 'info', 'dashboard', 'schedules', 'profile', etc. Multiple pages can be shown or hidden by passing a comma-separated list without spaces.
Version SpecificationThe process of specifying the Customer Portal version (e.g., Version 1 or Version 2) to be used for embedding, ensuring compatibility and access to specific features based on the chosen version.
Width and HeightDimensions specified for the iframe element to control its size within your webpage.

Event Notifications

TermDefinition
ActionsResponses triggered by events, such as sending webhooks, emails, SMS, or messages. Multiple actions can be selected to occur when an event is triggered.
Available PlaceholdersVariables that can be used in email bodies or webhook payloads, enclosed in double curly brackets (null), and replaced with actual values during event triggering. The available placeholders depend on the type of event being triggered.
ConditionsAdditional criteria used for filtering events to trigger specific actions. Event notifications matching conditions trigger actions, while those not meeting conditions do not. This allows for configuring complex event notifications based on specific attributes or conditions.
DelayAn option to delay sending event notifications to customers/subscribers, with choices like After a specified duration (days, weeks, months, years), On a specific date, or On a specific day of the week.
Email TemplateA configured email format used for sending email notifications, treated as a template where placeholders are replaced with actual values before sending.
EndpointThe URL where webhooks send their payloads upon event triggering.
Event NotificationsA service that informs you about critical events on your Subsbase site, allowing you to automate actions via webhooks, emails, SMS, and messages. It captures system changes related to customers, subscriptions, plans, and invoices.
HTML EmailEmail bodies formatted in HTML for visually appealing and customizable email notifications.
PlaceholdersVariables used in email templates or webhook payloads that are replaced with actual values during event triggering. They are enclosed in double curly brackets (null) and can be used in various fields like email bodies or webhook payloads.
Request MethodThe method used for sending webhook payloads, such as GET, POST, PUT, DELETE, etc.
Send EmailAction to send an email notification, with placeholders replaced by actual values in email templates.
Send MessageAction to send a message when integration is available.
Send SMSAction to send an SMS notification when integration is available.
Send WebhookAction to trigger a webhook, sending a payload to a specified URL upon event occurrence.
TriggerA specific event that occurs, such as "Subscription is renewed," which initiates an automated action, like sending an email to the customer.
WebhooksAutomated event-driven messages sent from one system to another, triggered by specific events. They immediately send a payload to a specified URL upon event occurrence. You can customize the request method and payload using placeholders.

API and Webhooks

API

TermDefinition
APIApplication Programming Interface; a set of rules and protocols for building and interacting with software applications.
API SecretA unique key used for authenticating API requests to ensure security and access control.
API IntegrationThe process of connecting and integrating different software systems or applications using APIs to share data and functionality.
AuthenticationThe process of verifying the identity of a user or application to ensure authorized access to resources and data.
Base URLThe starting point or root address of an API endpoint, used to construct API requests and access different resources.
Data Access RulesRules that define how data can be accessed and manipulated within a system, often based on user roles and permissions.
Event NotificationsAutomated notifications triggered by specific events in a system, often used to inform external systems about changes or actions.
GraphQLA query language for APIs that provides a complete and understandable description of data and allows precise data retrieval.
GraphQL ClientA software library or tool used to interact with GraphQL APIs, making it easier to send queries and mutations and handle responses.
MutationIn GraphQL, a mutation is used to modify data on the server, such as creating, updating, or deleting records.
QueryIn GraphQL, a query is a request for specific data from a server. It specifies the fields to be retrieved and their structure.
RESTfulRepresentational State Transfer; an architectural style for designing networked applications using HTTP methods for CRUD operations.
RuntimeThe environment where software applications run and execute code, including the processes and resources available during execution.
SSLSecure Sockets Layer; a security protocol that establishes an encrypted link between a web server and a browser, ensuring data security during transmission.
Webhook SecretA secret key used to validate incoming webhook requests, ensuring that they originate from a trusted source and are not tampered with.
WebhooksAutomated notifications sent by a server to a client application in response to specific events, enabling real-time communication between systems.

Webhooks

TermDefinition
Custom HeadersAdditional headers included in the webhook HTTP request for information or authorization purposes.
EndpointThe URL where the webhook sends its HTTP requests.
HMAC HashA cryptographic hash calculated using the HMAC algorithm for validating webhook payloads.
Hash VerificationThe process of verifying the calculated hash against the received signature to authenticate webhook payloads.
HTTP Status CodeA numeric code indicating the success or failure of an HTTP request (e.g., 200 for success).
PayloadThe data sent in the webhook's HTTP request body, typically in JSON format.
Regenerate Webhook SecretThe process of generating a new webhook secret key to maintain security if the current key is compromised.
Request MethodThe HTTP method used for webhook requests, such as PUT, POST, or PATCH.
Retry MechanismThe process of retrying webhook requests if initial requests fail, with incremental delays between retries.
Signature HeaderA header in the webhook request containing the HMAC hash for payload validation.
WebhookA callback mechanism that triggers HTTP requests to a specified endpoint based on configured events.
Webhook SecretA secret key used in conjunction with HMAC to authenticate webhook payloads and prevent tampering.

Authentication

TermDefinition
API SecretA secret key used to request server tokens and authenticate API requests, akin to a password and kept confidential.
Authentication FlowThe sequence of steps involved in verifying and granting access to Subsbase resources using tokens.
Authorization HeaderAn HTTP header used to include the JWT token in requests, typically preceded by the keyword "Bearer".
Customer TokenA token used to authenticate a specific customer, allowing actions on that customer's data only.
JWTJSON Web Token, a compact and self-contained way for securely transmitting information between parties as a JSON object.
Regenerate SecretThe process of generating a new API secret key to maintain security if the current key is compromised.
Server TokenA token used for backend-to-backend communication, providing full access to Subsbase account operations.
Site IDThe unique identifier for a Subsbase site, used in API requests and configurations.
Success FieldA field in API responses indicating the success or failure of an operation, typically returning true or false.
Value FieldA field in API responses containing the actual token value or relevant data after a successful operation.

Reports

TermDefinition
Cart AbandonmentOccurs when a customer leaves the Checkout page without completing the purchase by providing a valid payment method. The Cart Abandonment report records checkout attempts with session IDs, codes, and dates, providing insights into customer behavior during the checkout process.
MRR (Monthly Recurring Revenue)A metric that calculates the average revenue generated from each customer on a monthly basis. It includes revenue from active prepaid recurring plan subscriptions and addons subscriptions, helping in financial planning and customer-focused strategies.
MRR per CustomerThe Monthly Recurring Revenue per Customer is calculated by summing the monthly revenue from active prepaid recurring plans and addons subscriptions for each customer, providing an overview of revenue generation from subscribers.
ReportsThe Reports page on the Admin Portal provides insights and analysis for Cart Abandonment, MRR per Customer, and Term Limits, aiding in strategic decision-making and performance evaluation.
Term LimitsGoverns automatic subscription renewals or cancelations based on specified billing cycle or term durations. Setting term limits for plans helps determine whether subscriptions should automatically renew or end after the current billing cycle or term.