Skip to content

listUpgrades.md

Latest commit

 

History

History
124 lines (104 loc) · 3.25 KB

listUpgrades.md

File metadata and controls

124 lines (104 loc) · 3.25 KB

listUpgrades

List all upgrades.

Endpoint

POST /json/listUpgrades

Request Parameters

Parameter Type Required Description
from_product_id int No Filter by source product ID
to_product_id int No Filter by target product ID
is_active bool No Filter by active status
limit int No Results per page (default: 100, max: 500)
offset int No Pagination offset

Response

[
    'result' => 'success',
    'data' => [
        'upgrades' => [
            [
                'upgrade_id' => 789,
                'name' => 'Basic to Premium',
                'from_product_id' => 123,
                'from_product_name' => 'Basic Course',
                'to_product_id' => 124,
                'to_product_name' => 'Premium Course',
                'upgrade_price' => 49.00,
                'currency' => 'EUR',
                'is_active' => true,
                'conversions_count' => 87,
                'conversion_rate' => 12.5,
                'total_revenue' => 4263.00
            ],
            [
                'upgrade_id' => 790,
                'name' => 'Premium to VIP',
                'from_product_id' => 124,
                'from_product_name' => 'Premium Course',
                'to_product_id' => 125,
                'to_product_name' => 'VIP Course',
                'upgrade_price' => 99.00,
                'currency' => 'EUR',
                'is_active' => true,
                'conversions_count' => 45,
                'conversion_rate' => 8.3,
                'total_revenue' => 4455.00
            ]
            // ... more upgrades
        ],
        'total' => 24,
        'limit' => 100,
        'offset' => 0
    ]
]

Usage Example

use GoSuccess\Digistore24\Api\Digistore24;
use GoSuccess\Digistore24\Api\Client\Configuration;

// Initialize API client
$config = new Configuration('YOUR-API-KEY');
$api = new Digistore24($config);

// List all upgrades
$response = $api->upgrade()->listUpgrades(
    limit: 50
);

echo "Total upgrades: {$response->total}\n\n";
foreach ($response->upgrades as $upgrade) {
    echo "ID: {$upgrade->upgradeId}\n";
    echo "Name: {$upgrade->name}\n";
    echo "Path: {$upgrade->fromProductName} → {$upgrade->toProductName}\n";
    echo "Price: {$upgrade->currency} {$upgrade->upgradePrice}\n";
    echo "Conversions: {$upgrade->conversionsCount} ({$upgrade->conversionRate}%)\n";
    echo "Revenue: {$upgrade->currency} {$upgrade->totalRevenue}\n\n";
}

// Filter by source product
$response = $api->upgrade()->listUpgrades(
    fromProductId: 123
);

// Filter by target product
$response = $api->upgrade()->listUpgrades(
    toProductId: 124
);

// Filter active upgrades only
$response = $api->upgrade()->listUpgrades(
    isActive: true
);

// Pagination
$response = $api->upgrade()->listUpgrades(
    limit: 20,
    offset: 0
);

Error Responses

Code Message Description
400 Invalid parameters Invalid filter values or pagination parameters

Notes

  • Results ordered by creation date (newest first)
  • Includes conversion statistics and revenue
  • Max 500 results per request
  • Use pagination for large result sets
  • Filter combinations supported