Documentation menu

Documentation / Usage, billing, and keys

Usage, billing, and keys

A verified account is required for Explorer and optional but recommended for paid access. API keys remain separate credentials for applications and account controls.

On this page

Your subscription and key

After checkout, payment confirmation activates your subscription and makes the initial API key available on the completion page. The key is displayed once. Save it in a secret manager before closing that page.

Explorer starts only after email verification and remains attached to that durable passwordless account. Paid checkout still reveals its first key without requiring an account; link the key from Account to add verified-email sign-in and lost-key recovery. Verification links last 15 minutes, sessions last 30 days, and API keys are never emailed.

Your subscription key provides access to the API, usage dashboard, billing portal, and key-authorized organization controls. Store it securely. A website account does not replace Bearer-key authentication in an application.

Address and business search and regional POI discovery are included in every plan, using the same key and shared monthly allowance. No new key or add-on purchase is needed. See search and discovery request accounting for composed calls.

Read usage

Open Usage and billing and enter your key, or call the usage endpoint. This read does not consume query quota.

curl --fail-with-body "https://api.mapsource.io/usage" \
  -H "Authorization: Bearer $MAPSOURCE_API_KEY"
FieldContents
tierPlan name, prices, and limits.
entitlementCurrent access state.
billingWhether a billing portal is available and how the key is managed.
overageHard-stop or continuity policy, rate, cap, estimated charge, maximum tier, consent version, and service-level metering availability.
currentPeriodAuthoritative usage-period start and reset, accepted requests, and returned bytes.
last24HoursAccepted and unsuccessful requests, returned bytes, and p95 duration.
dailyDaily request and byte totals for the recent 30-day window. Days without records may be absent.

The dashboard keeps an entered key in memory for that visit; it is not saved in browser storage. See limits for quota reset semantics and response headers.

Invoices and cancellation

  1. Open Usage and billing with the key issued for your subscription.
  2. Select Manage billing to open Stripe’s customer portal.
  3. Review invoices, update payment information, or choose the portal’s cancellation option.
  4. Check the effective cancellation date shown by Stripe. Scheduled cancellation keeps access through the subscription’s remaining paid period.

The billing portal requires a key linked to a Stripe subscription. Demonstration and operator-issued keys may not have a billing profile.

If billing cannot be opened, contact [email protected] with your purchase email and support reference. Do not send your API key.

Replace a key

The authenticated POST /keys/rotate endpoint accepts {"confirm":true} and returns a new key. The prior key remains valid for 15 minutes so deployments can move without downtime. Perform this from a trusted server or private tool, save the new key without logging it, and update every application before the overlap ends.

If the response is lost and the organization is linked to a verified account, sign in and use lost-key recovery to rotate again. Otherwise contact support; raw keys cannot be retrieved.

Lost keys and support references

The MS-… receipt reference identifies your purchase for support. Account changes require ownership verification; the reference alone does not authorize access or cancellation.

If the organization is linked to your verified account, sign in at Account, choose the organization, and replace its human key. The replacement is shown once and the old key receives a 15-minute overlap. If no verified account was linked, contact support from the purchase email address and include the reference if available. Raw keys are not retrievable from usage records.

Data retention

Usage reporting stores request metadata such as route, timestamp, outcome, duration, and response size, not query text or returned OSM objects. Billing records and credential records serve separate account functions. The privacy policy describes retention and regional rights.

Questions about this guide? Contact support.