Matchplat API Docs

GET /license/info

Returns information about the user's active license, including enabled countries, credits, license type, and premium support details.

Response 200

Field Type Description
countries String[] List of enabled countryIso2 codes for the license
premiumSupportHours PremiumSupportHours Premium support hours details
exploreLicense ExploreLicense Explore license details

PremiumSupportHours

FieldTypeDescription
totalIntTotal premium support hours
deliveredIntDelivered hours
remainingIntRemaining hours

Credits (-1 means unlimited)

FieldTypeDescription
availableIntAvailable credits (-1 = unlimited)
totalIntTotal credits (-1 = unlimited)

ExploreLicense

FieldTypeDescription
financialCreditsCreditsFinancial credits
downloadsCreditsCreditsDownloads credits
emailGenerationCreditsCreditsEmail generation credits
licenseTypeLicenseTypeLicense type (ONE, LITE, PLUS)
exploreLitePropertiesExploreLicensePropertiesExplore Lite properties
explorePlusPropertiesExploreLicensePropertiesExplore Plus properties

ExploreLicenseProperties

FieldTypeDescription
isEnabledBooleanLicense enabled
isFreeTrialBooleanFree trial license
isAutoRenewBooleanAuto-renew enabled
priceFloatPrice in euro (€)
subscriptionTypeSubscriptionTypeSubscription type (MONTHLY, ANNUAL)
activationDateDateActivation date (RFC 3339, timezone)
expirationDateDateExpiration date (RFC 3339, timezone)
creditsCreditsAssociated credits

Enum LicenseType

Enum SubscriptionType

Example

{
  "countries": ["IT", "FR", "DE"],
  "premiumSupportHours": {
    "total": 10,
    "delivered": 4,
    "remaining": 6
  },
  "exploreLicense": {
    "financialCredits": { "available": 100, "total": 200 },
    "downloadsCredits": { "available": 50, "total": 100 },
    "emailGenerationCredits": { "available": 20, "total": 50 },
    "licenseType": "PLUS",
    "exploreLiteProperties": {
      "isEnabled": true,
      "isFreeTrial": false,
      "isAutoRenew": true,
      "price": 99.99,
      "subscriptionType": "MONTHLY",
      "activationDate": "2024-01-01T00:00:00Z",
      "expirationDate": "2025-01-01T00:00:00Z",
      "credits": { "available": 10, "total": 20 }
    },
    "explorePlusProperties": {
      "isEnabled": true,
      "isFreeTrial": false,
      "isAutoRenew": false,
      "price": 199.99,
      "subscriptionType": "ANNUAL",
      "activationDate": "2024-01-01T00:00:00Z",
      "expirationDate": "2025-01-01T00:00:00Z",
      "credits": { "available": 5, "total": 10 }
    }
  }
}

Example curl call

curl -X GET "/license/info" \
  -H "x-api-key: <API_KEY>"