Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mappingtravel.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Mapping.Travel provides several endpoints to help you understand how much of your quota you have consumed and what it has cost. Use real-time quota checks before starting jobs, inspect monthly totals for cost tracking, and pull up to 12 months of historical data for reporting.

​
Quota status

Call GET /api/v1/billing/quota/status to check your organization’s current quota in real time. This is the fastest way to determine whether your organization can run another mapping job right now. 
curl https://api.mapping.travel/api/v1/billing/quota/status \
  -H "Authorization: Bearer <your-token>"
Example response: 
{
  "canProceed": true,
  "message": "Quota available",
  "remainingQuota": 7,
  "usagePercentage": 30.0,
  "planType": "FREE",
  "mappingsPerDayLimit": 10,
  "mappingsUsedToday": 3,
  "maxSuppliers": 5,
  "creditBalance": null
}
FieldDescription
canProceedtrue if the organization can run another mapping job. false if the daily limit is reached and credits are exhausted.
remainingQuotaMapping jobs remaining today before credits are drawn
usagePercentagePercentage of the daily quota consumed (0–100)
mappingsPerDayLimitTotal daily mapping jobs allowed under your current plan
mappingsUsedTodayMapping jobs already run today
maxSuppliersMaximum number of suppliers your plan allows
creditBalanceCredit balance available for over-quota jobs, or null if no credits have been purchased
When canProceed is false and creditBalance is null, your organization has hit its daily limit with no credits remaining. Purchase credits or wait until the quota resets.

​
Plan details

Call GET /api/v1/billing/plan for a combined view of your plan configuration and current usage. This includes how many matches you have used this month, the cost so far, and how much quota remains. 
curl https://api.mapping.travel/api/v1/billing/plan \
  -H "Authorization: Bearer <your-token>"
Example response: 
{
  "planName": "SUBSCRIPTION",
  "displayName": "Subscription",
  "matchesPerMonth": null,
  "pricePerMatch": 0.000001,
  "matchesUsed": 42300,
  "monthlyTotalCost": 0.04,
  "quotaRemaining": 9957700,
  "usagePercentage": 0.42
}

​
Usage summary

Call GET /api/v1/billing/usage for a high-level summary of your organization’s API activity. 
curl https://api.mapping.travel/api/v1/billing/usage \
  -H "Authorization: Bearer <your-token>"

​
Current-month metrics

Call GET /api/v1/billing/metrics/current-month to see how many mappings your organization has processed this billing month and what they have cost so far. 
curl https://api.mapping.travel/api/v1/billing/metrics/current-month \
  -H "Authorization: Bearer <your-token>"
Example response: 
{
  "billingMonth": "2026-04",
  "matchesProcessed": 42300,
  "costPerMatch": 0.000001,
  "totalCost": 0.04,
  "usagePercentage": 0.42
}
FieldDescription
billingMonthMonth in YYYY-MM format
matchesProcessedTotal mapping jobs run this month
costPerMatchPer-mapping cost under your plan (in euros)
totalCostTotal amount accrued this month (in euros)
usagePercentageProportion of your monthly quota consumed

​
Historical metrics

Call GET /api/v1/billing/metrics/history to retrieve month-by-month metrics for up to the past 12 months. Use the limit query parameter to control how many months are returned. 
curl "https://api.mapping.travel/api/v1/billing/metrics/history?limit=12" \
  -H "Authorization: Bearer <your-token>"
Example response: 
[
  {
    "billingMonth": "2026-04",
    "matchesProcessed": 42300,
    "costPerMatch": 0.000001,
    "totalCost": 0.04,
    "usagePercentage": 0.0
  },
  {
    "billingMonth": "2026-03",
    "matchesProcessed": 198000,
    "costPerMatch": 0.000001,
    "totalCost": 0.20,
    "usagePercentage": 0.0
  }
]
The response is ordered from most recent to oldest. Set limit to any value from 1 to 12.

​
Organization statistics

Call GET /api/v1/statistics to retrieve aggregate counts for your organization: total inventory uploads, total mappings run, and the number of mapping results ready to export. 
curl https://api.mapping.travel/api/v1/statistics \
  -H "Authorization: Bearer <your-token>"
Check canProceed before submitting large mapping jobs to avoid unexpected credit consumption.
# 1. Check quota
curl https://api.mapping.travel/api/v1/billing/quota/status \
  -H "Authorization: Bearer <your-token>"

# 2. If canProceed is true, submit your job
curl -X POST https://api.mapping.travel/api/v1/mapping \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{ "partnerInventoryId": "inv_abc123", "mode": "STANDARD" }'