Sistema di crediti
Comprenda come funzionano i crediti VynCo — costi per operazione, quote per livello, fatturazione del consumo eccessivo e best practice
How It Works
Every API operation that retrieves or generates data costs a fixed number of credits. Credits are deducted from your team's monthly balance when a request succeeds. Management operations (balance, API keys, team info) are always free.
Fixed per-operation cost
Each endpoint has a deterministic credit cost. No surprise charges based on response size.
Debit on success only
Credits are only consumed on HTTP 2xx responses. Failed requests are never charged.
Real-time visibility
Every response includes X-Credits-Used and X-Credits-Remaining headers.
Operation Costs
The table below lists the credit cost for every API operation. Simple lookups cost 1 credit; AI dossiers scale with depth.
| Operation | Endpoint | Credits | Available on |
|---|---|---|---|
| Company Search | GET /companies | 1 credit | All |
| Company Lookup (by UID) | GET /companies/{uid} | 1 credit | All |
| Company Count | GET /companies/count | 1 credit | All |
| Company Statistics | GET /companies/statistics | 1 credit | All |
| Enriched Profile | GET /companies/{uid} (enriched) | 5 credits | Starter+ |
| Change Feed Query | GET /changes | 2 credits | Starter+ |
| Company Change History | GET /changes/company/{uid} | 2 credits | Starter+ |
| Person Lookup | GET /persons/{uid} | 3 credits | Starter+ |
| Person Search | POST /persons/search | 3 credits | Starter+ |
| Dossier — Summary | POST /dossiers (level: summary) | 20 credits | Professional+ |
| Dossier — Standard | POST /dossiers (level: standard) | 50 credits | Professional+ |
| Dossier — Comprehensive | POST /dossiers (level: comprehensive) | 100 credits | Professional+ |
| Timeline Export | POST /timeline/export | 10 credits | Professional+ |
| Clustering (K-Means / GMM) | POST /analytics/cluster | 15 credits | Professional+ |
| Anomaly Detection (Z-score / DBSCAN) | POST /analytics/anomalies | 15 credits | Professional+ |
| Cohort Analysis | GET /analytics/cohorts | 20 credits | Professional+ |
| Company Relationships | GET /companies/{uid}/relationships | 10 credits | Starter+ |
| Company Hierarchy Tree | GET /companies/{uid}/hierarchy | 10 credits | Starter+ |
| Company News | GET /companies/{uid}/news | 2 credits | Starter+ |
| Recent News Feed | GET /news/recent | 1 credit | All |
| Financial Reports | GET /companies/{uid}/reports | 5 credits | Starter+ |
| Company Comparison | POST /companies/compare | 5 credits | Starter+ |
Tier Allowances
Each plan includes a monthly credit allowance. Credits reset at the start of every billing period and do not roll over.
| Tier | Price | Included Credits | Overage |
|---|---|---|---|
| Free | CHF 0/mo | 1,000 | Blocked |
| Starter | CHF 99/mo | 50,000 | 0.3¢/credit |
| Professional | CHF 399/mo | 250,000 | 0.2¢/credit |
| Enterprise | Custom | 1,000,000+ | 0.1¢/credit |
Need more credits? Compare plans or contact sales for a custom Enterprise arrangement.
Overage Billing
When a paid tier exhausts its included credits, additional credits are automatically consumed from an overage pool. Overage is billed at the end of the billing period.
Overage example (Starter tier):Monthly included credits: 50,000Credits used this month: 52,500Overage credits: 2,500Overage rate: CHF 0.003/creditOverage charge: CHF 7.50Billed at period end on top of the CHF 99/mo subscription.The Free tier does not support overage — requests are blocked once the 1,000 credit allowance is exhausted. Upgrade to Starter or above to enable overage billing.
Tracking Your Usage
Monitor credit consumption via the API, response headers, or the Usage dashboard.
Credit Balance
# Check current credit balancecurl "https://api.vynco.ch/v1/credits/balance" \ -H "Authorization: Bearer vc_live_abc123..."{ "balance": 48750, "tier": "starter", "periodStart": "2026-03-01T00:00:00Z", "periodEnd": "2026-03-31T23:59:59Z"}Usage Breakdown
# Get usage breakdown by operationcurl "https://api.vynco.ch/v1/credits/usage" \ -H "Authorization: Bearer vc_live_abc123..."{ "period": { "start": "2026-03-01T00:00:00Z", "end": "2026-03-31T23:59:59Z" }, "totalUsed": 1250, "breakdown": [ { "operation": "CompanySearch", "count": 840, "creditsUsed": 840 }, { "operation": "EnrichedProfile", "count": 62, "creditsUsed": 310 }, { "operation": "DossierSummary", "count": 5, "creditsUsed": 100 } ]}Per-Response Headers
# Credits are also returned in every response headerHTTP/2 200X-Credits-Used: 5X-Credits-Remaining: 48750X-Rate-Limit-Limit: 60X-Request-Id: req_abc123X-Data-Source: ZefixBest Practices
Follow these guidelines to make the most of your credit allowance.
Cache company lookups
Company data changes infrequently. Cache GET /companies/{uid} responses for at least 24 hours to avoid redundant credit spend.
Use search before lookup
A search (1 credit) returns UIDs in bulk. Only fetch enriched profiles (5 credits) for companies you actually need.
Monitor X-Credits-Remaining
Log the X-Credits-Remaining header in every response. Alert your team when the balance drops below a threshold.
Choose the right dossier level
Use level: summary (20 cr) for quick screening. Reserve level: comprehensive (100 cr) for final due diligence.
Poll /credits/usage regularly
Set up a daily cron job that calls GET /credits/usage and reports per-operation totals to your team.
Use test keys in CI
vc_test_* keys run in sandbox mode and do not consume credits. Use them in automated tests and staging environments.
Frequently Asked Questions
Common questions about the credit system.