Purchase Plans

With the Payments Library, users/subscribers can purchase Payment Plans by paying. The process is simple and secure. The Subscriber needs to have enough funds in their wallet to pay for the Plan in the token selected by the creator of the Plan. In Nevermined, the Payment Plan creators can request the payments in any valid ERC20 or Native token (depending on the network where the Plan is created). When the Payment Plan requires a payment in Fiat, the payment can be initiated with the libraries, but the final step needs to be done in the Nevermined App. The App will handle the payment in Fiat (Stripe integration) and will return the user to the application with the Payment Plan purchased.

Payment Methods

Nevermined supports both cryptocurrency and fiat payment methods, providing flexibility for all types of users.

Cryptocurrency Payments

For users with crypto wallets, direct blockchain payments offer instant settlement:

TypeScript
Python

// Purchase plan with cryptocurrency
const purchaseResult = await payments.plans.orderPlan(planId)
// OUTPUT: purchaseResult: 
// {
//   txHash: '0x5b95ebaec594b6d87e688faddf85eec3d708e6a06e61864699e5a366af1343f6',
//   success: true
// }

# Purchase plan with cryptocurrency
purchase_result = payments.order_plan(plan_DID)  
# OUTPUT: purchaseResult: 
#  { success: True, agreementId: '0xaabbcc' }   

Fiat Payments

For users preferring traditional payment methods, Stripe integration provides credit card support:

TypeScript
Python

// Get fiat payment configuration
const fiatConfig = await payments.plans.getFiatPriceConfig(planId)

// Purchase plan with fiat payment
const { sessionId, url } = await payments.plans.orderFiatPlan(planId)

// Redirect user to Stripe checkout
window.location.href = url

// After successful payment, user will be redirected back with the plan active

# Get fiat payment configuration
fiat_config = payments.plans.get_fiat_price_config(plan_id)

# Purchase plan with fiat payment
fiat_result = payments.plans.order_fiat_plan(plan_id)

# Redirect user to Stripe checkout
print(f'Stripe checkout URL: {fiat_result["url"]}')
# User completes payment on Stripe and returns to your application

Checking the Balance of a Payment Plan

After a user purchases a plan, they can check their balance for that plan. The balance represents the number of credits the user has available to use within the plan.

Time-based plans provide a balance of 1 credit for subscribers. When the plan expires, this balance will be zero.

TypeScript
Python

const balanceResult = await payments.plans.getPlanBalance(planId)
// OUTPUT: balanceResult:
// {
//   planId: '84262690312400469275420649384078993542777341811308941725027729655403981619104',
//   planType: 'credits',
//   holderAddress: '0x8924803472bb453b7c27a3C982A08f7515D7aA72',
//   creditsContract: '0x17FaFabF74312EdaBEB1DB9f0CaAccd44aAFDE39',
//   balance: '100',
//   isSubscriber: true
// }

balance_result = payments.get_plan_balance(plan_DID)
# OUTPUT: balanceResult:
# {
#   "planType": "credits",
#   "isSubscriptor": True,
#   "isOwner": False,
#   "balance": 10000000
# }  

Understanding Plan Types and Balances

Credits-Based Plans

Users receive a specific number of credits upon purchase. Each API call consumes credits based on your configuration.

Time-Based Plans

Users receive 1 credit that grants unlimited access for the specified duration. Balance becomes 0 when expired.

Payment Flow Examples

Complete Purchase Flow

Discover Plans

Users browse available payment plans and select one that fits their needs

Initiate Purchase

Call orderPlan() or orderFiatPlan() depending on payment method

Complete Payment

For crypto: transaction is processed on-chain For fiat: user completes Stripe checkout

Verify Purchase

Check balance to confirm the plan was successfully purchased

Access Services

Use the plan to access AI agents and services

Error Handling

TypeScript
Python

try {
  const purchaseResult = await payments.plans.orderPlan(planId)
  
  if (purchaseResult.success) {
    console.log('Plan purchased successfully!')
    console.log('Transaction hash:', purchaseResult.txHash)
    
    // Check balance to confirm
    const balance = await payments.plans.getPlanBalance(planId)
    console.log('Available credits:', balance.balance)
  }
} catch (error) {
  console.error('Purchase failed:', error.message)
  
  if (error.message.includes('insufficient funds')) {
    console.log('Please ensure you have enough tokens in your wallet')
  } else if (error.message.includes('user rejected')) {
    console.log('Transaction was cancelled by user')
  }
}

try:
    purchase_result = payments.order_plan(plan_id)
    
    if purchase_result.get('success'):
        print('Plan purchased successfully!')
        print(f'Agreement ID: {purchase_result.get("agreementId")}')
        
        # Check balance to confirm
        balance = payments.get_plan_balance(plan_id)
        print(f'Available credits: {balance.get("balance")}')
        
except Exception as error:
    print(f'Purchase failed: {error}')
    
    if 'insufficient funds' in str(error):
        print('Please ensure you have enough tokens in your wallet')
    elif 'user rejected' in str(error):
        print('Transaction was cancelled by user')

Integration Examples

Web Application Integration

// React component example
const PlanPurchase = ({ planId, planDetails }) => {
  const [purchasing, setPurchasing] = useState(false)
  const [balance, setBalance] = useState(null)
  
  const handlePurchase = async () => {
    setPurchasing(true)
    try {
      const result = await payments.plans.orderPlan(planId)
      if (result.success) {
        const newBalance = await payments.plans.getPlanBalance(planId)
        setBalance(newBalance.balance)
        toast.success('Plan purchased successfully!')
      }
    } catch (error) {
      toast.error(`Purchase failed: ${error.message}`)
    } finally {
      setPurchasing(false)
    }
  }
  
  return (
    <div>
      <h3>{planDetails.name}</h3>
      <p>Price: {planDetails.price} {planDetails.token}</p>
      <button onClick={handlePurchase} disabled={purchasing}>
        {purchasing ? 'Processing...' : 'Purchase Plan'}
      </button>
      {balance && <p>Available credits: {balance}</p>}
    </div>
  )
}

Next Steps

After users purchase plans, they can:

Query AI Agents

Learn how to access AI services with purchased plans

Monitor Usage

Track credit usage and plan status

Getting Started

Integration Guide

Payment Methods

Cryptocurrency Payments

Fiat Payments

Checking the Balance of a Payment Plan

Understanding Plan Types and Balances

Credits-Based Plans

Time-Based Plans

Payment Flow Examples

Complete Purchase Flow

Error Handling

Integration Examples

Web Application Integration

Next Steps

Query AI Agents

Monitor Usage

​Payment Methods

​Cryptocurrency Payments

​Fiat Payments

​Checking the Balance of a Payment Plan

​Understanding Plan Types and Balances

Credits-Based Plans

Time-Based Plans

​Payment Flow Examples

​Complete Purchase Flow

​Error Handling

​Integration Examples

​Web Application Integration

​Next Steps

Query AI Agents

Monitor Usage

Payment Methods

Cryptocurrency Payments

Fiat Payments

Checking the Balance of a Payment Plan

Understanding Plan Types and Balances

Payment Flow Examples

Complete Purchase Flow

Error Handling

Integration Examples

Web Application Integration

Next Steps