Younium MCP server

Introduction

The Younium MCP (Model Context Protocol) connector enables seamless AI integration with your Younium subscription and billing management platform. This guide outlines the available methods to help you maximize the value of this integration.

[Younium MCP server is in November 2025 released as beta-release.]

What is an MCP Server?

An MCP (Model Context Protocol) server is a standardized interface that connects external applications and data sources to AI models and assistants. Think of it as a bridge that allows AI systems to safely and reliably access real business data and functionality without requiring direct database access or complex custom integrations. The Younium MCP server specifically acts as a secure gateway between AI assistants and your Younium billing and subscription data, enabling these systems to retrieve customer information, financial metrics, subscription details, and invoice data on demand. MCP servers follow strict protocols for authentication, data privacy, and method validation, ensuring that only authorized requests are processed and sensitive information is protected. By using an MCP server, you get the benefits of AI-powered insights and automation while maintaining full control over what data can be accessed, how it's used, and maintaining comprehensive audit trails of all interactions.

 

Methods Summary

The Younium MCP connector provides five core methods for accessing your subscription and billing data:

1. GetCustomers

Purpose: Retrieve a list of your customers with flexible sorting and pagination options.

Key Features:

  • Retrieve all customers or a specific subset using pagination
  • Sort by creation date (oldest or newest first) or modification date
  • Useful for discovering new customers, recently updated accounts, or building customer lists
  • Default returns 100 results; customize page size as needed

Common Parameters:

  • pageSize: Number of results to return (default: 100)
  • orderBy: Sort field ('created' for creation date, 'modified' for modification date)
  • sortDirection: Sort order ('asc' for ascending, 'desc' for descending)

Use Cases:

  • Identify recently onboarded customers
  • Generate comprehensive customer lists

  • Monitor customer portfolio changes

     

2. GetCustomerMetrics

Purpose: Retrieve comprehensive financial metrics for a specific customer.

Key Features:

  • Access detailed financial performance data for individual customers
  • Metrics include revenue indicators, growth trends, and health scores
  • Single customer lookup for targeted analysis
  • Support for customer health monitoring and risk assessment

Required Parameters:

  • customerName: Name of the target customer

Use Cases:

  • Monitor customer financial health
  • Identify upsell or cross-sell opportunities
  • Track customer growth trajectory
  • Support customer success planning
  • Identify at-risk accounts

 

3. GetSubscriptions

Purpose: Retrieve all subscriptions associated with a specific customer.

Key Features:

  • View complete subscription portfolio for any customer
  • Supports pagination for customers with multiple subscriptions
  • Enables subscription-level analysis and management
  • Track all active and historical subscriptions

Required Parameters:

  • customerName: Name of the target customer

Optional Parameters:

  • pageSize: Number of results to return (default: 100)

Use Cases:

  • View customer subscription portfolio
  • Support subscription renewal planning
  • Analyze subscription diversity per customer
  • Track subscription history

 

4. GetSubscriptionMetrics

Purpose: Retrieve detailed financial metrics for a specific subscription.

Key Features:

  • Access performance data for individual subscriptions
  • Order-level analysis for detailed billing insights
  • Support for subscription health monitoring

Required Parameters:

  • orderNumber: Order number of the target subscription

Use Cases:

  • Monitor individual subscription performance
  • Track subscription-level revenue metrics
  • Support subscription renewal decisions
  • Identify high-value subscriptions

 

5. GetInvoices

Purpose: Retrieve invoices for a specific customer with status filtering and date-based sorting.

Key Features:

  • Filter invoices by status (Posted, Settled, Draft, Cancelled)
  • Sort by invoice date to find recent or historical invoices
  • Default retrieves Posted and Settled invoices
  • Supports pagination for customers with large invoice histories
  • Essential for accounting, revenue recognition, and payment tracking

Required Parameters:

  • customerName: Name of the target customer

Optional Parameters:

  • pageSize: Number of results to return (default: 100)
  • orderBy: Sort field ('invoiceDate' for chronological sorting)
  • sortDirection: Sort order ('asc' for oldest first, 'desc' for newest first)
  • status: Invoice status filter (Posted, Settled, Draft, Cancelled)

Use Cases:

  • Track customer payment history
  • Monitor outstanding invoices
  • Generate accounting reports
  • Analyze payment patterns
  • Identify customers with payment issues

 

How to connect to the Younium MCP server

Younium’s MCP server supports two different authentication methods.

Which one you use depends on the client or platform you are connecting from, as different systems support different authentication mechanisms.

  • MCP JSON–based authentication Used by tools that allow direct MCP configuration files (for example Cursor).
  • OAuth authentication Used by hosted AI platforms such as ChatGPT and Claude.

Note on permissions and availability

Some AI platforms place additional restrictions on MCP or custom connector usage.

For example, ChatGPT requires developer mode access to create and configure MCP-based apps. Availability and permissions may vary depending on your plan, organization settings, or workspace configuration.

You must use the authentication method supported by the system you are setting up.

 

Option 1: Connect using MCP JSON authentication (Cursor)

This method is used by tools that support direct MCP configuration via a JSON file.

Steps

  1. Open Settings → Tools & MCP 
  2. Select New MCP Server 
  3. Add the following configuration to your MCP JSON file:

{
  "mcpServers": {
    "Younium": {
      "url": "https://mcp.younium.com",
      "headers": {
        "ApiKey": "APIKEY",
        "ApiSecret": "APISECRET",
        "LegalEntity": "Younium company"
      },
      "description": "Younium MCP Server"
    }
}
}

Authentication details

APIKEY and APISECRET are personal access tokens created in Younium Instructions for creating these tokens can be found here: https://developer.younium.com/get-started

This authentication method is typically used for developer tools and local environments.

 

 

Option 2: Connect using OAuth authentication (ChatGPT or Claude)

This method is used by platforms that require OAuth-based authentication.

 

Platform requirements

When connecting from hosted LLM platforms (such as ChatGPT or Claude), you may need specific permissions to create custom connectors or apps.

For example, ChatGPT only allows MCP/OAuth setup for users with developer mode access enabled. If you do not see the required options, check your account permissions or contact your workspace administrator.

 

ChatGPT

  1. Open Workspace Settings 
  2. Go to Apps 
  3. Click Create

 

Claude

  1. Open Settings 
  2. Go to Connectors 
  3. Click Add custom connector

 

App configuration

Use the following settings when creating the app:

Authentication 

  • OAuth 
  • Client ID 
    • Production: 17d011e9-370b-4a4b-a3f5-efbca620c77c 
    • Sandbox: 7fc70fb2-c5e2-42b0-88c9-8b316b0d3dc7 

 

OAuth authentication is typically used for hosted AI platforms where users authenticate interactively.