Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mapping.travel/llms.txt

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

The quota and usage endpoints give you full visibility into your organization’s consumption. Use the quota status endpoint to determine whether mappings can run right now, the credit balance endpoint to track pay-as-you-go spend, the usage summary for a current-period overview, and the metrics endpoints for historical trend data.
All endpoints on this page require authentication. Include your bearer token in the Authorization header.

​
GET /api/v1/billing/quota/status

Get your organization’s real-time quota status. 
GET https://api.mapping.travel/api/v1/billing/quota/status
This is the primary endpoint for enforcing quota before initiating a mapping job. Check canProceed before submitting large batches.

​
Response

​
canProceed
boolean
required
Whether your organization can run mappings right now. false means you have exhausted your daily limit or credit balance.
​
message
string
required
Human-readable explanation of the current quota state.
​
remainingQuota
number
required
Number of mappings remaining before your limit is reached.
​
usagePercentage
number
required
Percentage of the quota consumed. Value between 0 and 100.
​
planType
string
required
Your active plan type (e.g. FREE, SUBSCRIPTION, ENTERPRISE).
​
quotaType
string
required
The quota enforcement mechanism in use: daily_limit or credit_balance.
​
mappingsPerDayLimit
number
required
Your plan’s daily mapping limit.
​
mappingsUsedToday
number
required
Number of mappings you have run today.
​
maxSuppliers
number
required
Maximum number of suppliers your plan allows.
​
creditBalance
number
Remaining pay-as-you-go credit balance. Only present when your quota type is credit_balance and the balance is greater than zero.

​
Example

curl https://api.mapping.travel/api/v1/billing/quota/status \
  -H "Authorization: Bearer <token>"

{
  "canProceed": true,
  "message": "Quota available",
  "remainingQuota": 4750,
  "usagePercentage": 5.0,
  "planType": "SUBSCRIPTION",
  "quotaType": "daily_limit",
  "mappingsPerDayLimit": 5000,
  "mappingsUsedToday": 250,
  "maxSuppliers": 10,
  "creditBalance": null
}

​
GET /api/v1/billing/credits/balance

Retrieve your pay-as-you-go credit balance. 
GET https://api.mapping.travel/api/v1/billing/credits/balance

​
Response

​
creditsRemaining
number
required
Raw credit units remaining. 1 million credits = 1 million mappings = €1.
​
creditsUsed
number
required
Total credit units consumed to date.
​
totalSpent
number
required
Total amount spent in euros across all credit purchases.

​
Example

curl https://api.mapping.travel/api/v1/billing/credits/balance \
  -H "Authorization: Bearer <token>"

{
  "creditsRemaining": 12500000,
  "creditsUsed": 2500000,
  "totalSpent": 15.00
}

​
GET /api/v1/billing/usage

Retrieve a cumulative usage summary for your organization in the current billing period. 
GET https://api.mapping.travel/api/v1/billing/usage

​
Response

​
period
string
The billing period this summary covers (e.g. 2026-04).
​
totalMappings
number
Total number of mappings processed in this period.
​
totalCost
number
Total cost accrued this period in euros.
​
bySupplier
object[]
Breakdown of usage per connected supplier.

​
Example

curl https://api.mapping.travel/api/v1/billing/usage \
  -H "Authorization: Bearer <token>"

​
GET /api/v1/billing/metrics/current-month

Retrieve detailed metrics for the current calendar month. 
GET https://api.mapping.travel/api/v1/billing/metrics/current-month

​
Response

​
billingMonth
string
required
Month identifier in YYYY-MM format.
​
matchesProcessed
number
required
Total matches processed this month.
​
costPerMatch
number
required
Cost per match in euros for this billing period.
​
totalCost
number
required
Total cost for this month in euros.
​
usagePercentage
number
required
Percentage of your monthly quota consumed.

​
Example

curl https://api.mapping.travel/api/v1/billing/metrics/current-month \
  -H "Authorization: Bearer <token>"

{
  "billingMonth": "2026-04",
  "matchesProcessed": 43200,
  "costPerMatch": 0.000001,
  "totalCost": 0.0432,
  "usagePercentage": 28.8
}

​
GET /api/v1/billing/metrics/history

Retrieve historical monthly metrics. 
GET https://api.mapping.travel/api/v1/billing/metrics/history

​
Query parameters

​
limit
number
default:"12"
Number of past months to return, up to 12. Results are ordered from most recent to oldest.

​
Response

Returns an array of monthly metrics objects, using the same schema as GET /api/v1/billing/metrics/current-month.
​
billingMonth
string
required
Month in YYYY-MM format.
​
matchesProcessed
number
required
Matches processed in that month.
​
costPerMatch
number
required
Cost per match for that billing period.
​
totalCost
number
required
Total cost for that month in euros.

​
Example

curl "https://api.mapping.travel/api/v1/billing/metrics/history?limit=3" \
  -H "Authorization: Bearer <token>"

[
  { "billingMonth": "2026-04", "matchesProcessed": 43200, "costPerMatch": 0.000001, "totalCost": 0.0432 },
  { "billingMonth": "2026-03", "matchesProcessed": 98700, "costPerMatch": 0.000001, "totalCost": 0.0987 },
  { "billingMonth": "2026-02", "matchesProcessed": 71500, "costPerMatch": 0.000001, "totalCost": 0.0715 }
]