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.

Every Mapping.Travel account has a daily mapping quota — the number of mapping jobs you can run per calendar day. When you hit your limit, you can either wait for the quota to reset the next day or use credits to run additional jobs immediately. Credits are pay-as-you-go: one credit unlocks one mapping job beyond your daily limit.

​
Plans

PlanDaily mapping limit
Free10 mapping jobs/day
SubscriptionHigher limit (see your plan details)
On the free plan, you can run up to 10 mapping jobs per day at no cost. Subscription plans raise that limit. If you consistently hit your limit, upgrading to a subscription plan is more cost-effective than buying credits.

​
Credits

Credits let you run mapping jobs beyond your daily quota without upgrading your plan. Each credit equals one mapping job. Credits do not expire. When you submit a mapping job and your daily quota is already exhausted, the API automatically deducts one credit from your balance. If you have no credits remaining and your quota is full, the API returns 403 Forbidden.

​
Check your quota status

Get a real-time snapshot of your quota and credit balance: 
curl https://api.mapping.travel/api/v1/billing/quota/status \
  -H "Authorization: Bearer <your-token>"

{
  "canProceed": true,
  "message": "Quota available",
  "remainingQuota": 7,
  "usagePercentage": 30.0,
  "planType": "FREE",
  "quotaType": "DAILY",
  "mappingsPerDayLimit": 10,
  "mappingsUsedToday": 3,
  "maxSuppliers": 5,
  "creditBalance": 50
}
FieldDescription
canProceedWhether you can start a new mapping job right now
remainingQuotaMapping jobs left in your current quota period
mappingsUsedTodayJobs run today
mappingsPerDayLimitYour plan’s daily limit
creditBalanceAvailable credits (only shown when you have credits)

​
Check your credit balance

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

{
  "creditsRemaining": 50,
  "creditsUsed": 0,
  "totalSpent": "0.00"
}

​
View usage history

See a summary of your mapping usage across billing periods: 
curl https://api.mapping.travel/api/v1/billing/usage \
  -H "Authorization: Bearer <your-token>"
Use the usage endpoint to track consumption trends and decide whether to upgrade your plan or buy credits.

​
Purchase credits

Buy credits to extend your daily quota on demand. Submit a purchase request — the API creates a Stripe checkout session and returns a URL to complete payment. 
curl -X POST https://api.mapping.travel/api/v1/billing/credits/purchase \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "quantity": 100
  }'

{
  "checkoutUrl": "https://checkout.stripe.com/...",
  "sessionId": "cs_live_..."
}
Redirect your user to checkoutUrl to complete the purchase. Credits are added to your account automatically once payment succeeds.

​
Upgrade your plan

To move from the free plan to a subscription, create a checkout session: 
curl -X POST https://api.mapping.travel/api/v1/billing/checkout \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "planType": "SUBSCRIPTION",
    "successUrl": "https://your-app.example.com/billing/success",
    "cancelUrl": "https://your-app.example.com/billing/cancel"
  }'
The response contains a checkoutUrl. Redirect the user there to complete the subscription through Stripe.

​
Manage your subscription

To access the Stripe customer portal — where you can update payment methods, view invoices, or cancel your subscription — create a portal session: 
curl -X POST https://api.mapping.travel/api/v1/billing/portal \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "returnUrl": "https://your-app.example.com/settings/billing"
  }'
Redirect the user to the portalUrl in the response.

​
Available plans

To see all plan options with pricing and feature details: 
curl https://api.mapping.travel/api/v1/billing/plans \
  -H "Authorization: Bearer <your-token>"
The response lists each available plan with its daily mapping limit, maximum suppliers, monthly price, and any included credits.
If both your daily quota and credit balance are exhausted, the mapping API returns 403 Forbidden. Purchase credits or upgrade your plan before submitting more jobs.