PayPal Checkout – Display Name Handling for Multi-Brand

This document explains how Jframework generates the checkout item name when creating a PayPal Order for each brand. It also describes how brand administrators can customize the display name without needing to understand or modify code.

---

1. Overview

When a user is redirected to PayPal for checkout, PayPal requires an item name (and optionally a description) to display on the payment page.

In JFramework multi-brand configuration, the checkout item name is built using a combination of:

• Brand

• Package

• Price

• Currency

• Amount

• Return / Cancel URLs

The important part for branding is how the item name is displayed, so that each brand can present a clear and consistent label (e.g., “Premium Plan – Monthly”).

---

2. How the Display Name Is Generated

The system uses the following logic to determine the PayPal item name:

Display Name Rules

1. If the Price has a Description → use it as the display name. Example:

   • Price Description: “Premium Monthly Subscription” → PayPal item name = “Premium Monthly Subscription”

2. If the Price has no Description → fallback to:

   PackageName - PriceName

   Example:

   • Package Name: “Premium”

   • Price Name: “Monthly” → PayPal item name = “Premium – Monthly”

3. If either part is missing, the system replaces it with:

   • “Unnamed Package”

   • “Unnamed Price”

This ensures the PayPal item name is always valid and user-friendly.

---

3. Example of System Behavior

Case A – Price has a Description

Package Name	Price Name	Price Description	Display Name
Premium	Monthly	Premium Monthly Plan	Premium Monthly Plan

Case B – Price Description is empty

Package Name	Price Name	Display Name
Premium	Monthly	Premium – Monthly

Case C – Missing names

Package Name	Price Name	Display Name
(empty)	Monthly	Unnamed Package – Monthly

---

4. What Is Sent to PayPal

When creating an Order, JFramework sends the following fields to PayPal:

• brandName → Brand display name

• name → Display Name generated by the logic above

• description → Price description (if available)

• currency → Selected currency

• amount → Final amount after calculation

• returnUrl → Redirect after successful payment

• cancelUrl → Redirect if user cancels payment

This ensures PayPal shows a clean, brand-specific checkout item.

---

5. How Admins Can Customize the Display Name

Brand administrators can control what appears on the PayPal checkout page by editing:

1. Price Description (Recommended)

• Go to Admin → Subscription → Packages → Prices → Edit Price

• Enter a clear, user-friendly text in Description

• This will override everything else and become the PayPal item name.

Examples of good descriptions:

• “Premium Monthly Subscription”

• “Gold Package – 30 Days Access”

• “One-Time Setup Fee”

2. Customize Package Name / Price Name

If no description is entered, the system uses:

PackageName - PriceName

Admins can edit these fields under:

• Admin → Packages

• Admin → Prices

3. Best Practice for Branding

To ensure a consistent checkout experience:

• Always fill in Price Description when possible

• Use brand-friendly wording

• Avoid internal technical terms or codes

---

6. Summary

What You Want	What You Should Update
Fully custom PayPal item name	Price Description
Structured name (Package – Price)	Leave Description blank; update Package + Price names
Avoid ugly fallback labels	Make sure names are not empty

The system automatically ensures the best possible display name is shown to the user at checkout.