Quick Start Guide
Get up and running with SubLoop's payment analytics API in 5 minutes.
1. Get Your API Key
First, you'll need to get your API key from your SubLoop dashboard:
- Log in to your SubLoop dashboard
- Navigate to API Clients
- Create a new API client or copy an existing API key
2. Choose Your SDK
SubLoop provides SDKs for multiple programming languages:
3. Install the SDK
Install the SDK for your chosen platform:
composer require subloop/php-sdk
npm install subloop-react
4. Track Your First Payment
Here's how to track a successful payment:
<?php
use SubLoop\SubLoop;
$subloop = new SubLoop('sk_your_api_key_here');
$payment = $subloop->payments->createSuccessful(
customerId: 'cust_001',
amount: 29.99,
currency: 'USD',
subscriptionId: 'sub_001'
);
echo "Payment tracked: " . $payment['id'];
const SubLoop = require('subloop-js');
const subloop = new SubLoop('sk_your_api_key_here');
const payment = await subloop.payments.createSuccessful(
'cust_001', // customerId
29.99, // amount
'USD', // currency
'sub_001' // subscriptionId
);
console.log('Payment tracked:', payment.id);
import { SubLoopProvider, usePaymentTracking } from 'subloop-react';
function PaymentButton() {
const { trackSuccessfulPayment } = usePaymentTracking();
const handlePayment = async () => {
const payment = await trackSuccessfulPayment(
'cust_001', 29.99, 'USD', 'sub_001'
);
console.log('Payment tracked:', payment.id);
};
return ;
}
function App() {
return (
);
}
import 'package:subloop/subloop.dart';
final subloop = SubLoop('sk_your_api_key_here');
final payment = await subloop.payments.createSuccessful(
'cust_001',
29.99,
currency: 'USD',
subscriptionId: 'sub_001',
);
print('Payment tracked: ${payment['id']}');
5. View Analytics
Get insights from your payment data:
// Get dashboard overview
$overview = $subloop->analytics->getOverview();
echo "MRR: $" . $overview['mrr'];
// Get MRR growth
$mrr = $subloop->analytics->getMRR();
echo "Growth: " . $mrr['growth_percentage'] . "%";
// Get dashboard overview
const overview = await subloop.analytics.getOverview();
console.log(`MRR: $${overview.mrr}`);
// Get MRR growth
const mrr = await subloop.analytics.getMRR();
console.log(`Growth: ${mrr.growth_percentage}%`);
import { useAnalytics } from 'subloop-react';
function Dashboard() {
const { data, loading } = useAnalytics(client);
if (loading) return Loading...
;
return (
MRR: ${data.overview.mrr}
Growth: {data.mrr.growth_percentage}%
);
}
// Get dashboard overview
final overview = await subloop.analytics.getOverview();
print('MRR: \$${overview['mrr']}');
// Get MRR growth
final mrr = await subloop.analytics.getMRR();
print('Growth: ${mrr['growth_percentage']}%');
Next Steps
🎉 You're all set!
You've successfully integrated SubLoop's payment analytics. Here's what to explore next:
Need Help?
If you run into any issues: