Menu
Platform
AI
App store purchases
Credits
Database
Flags
Generated Assets
Monitoring
Notifications
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
On this page
Credits
What a Credit Grant is, and how it offsets what a customer is invoiced.
Credits lets you give your customers credit that their invoices spend. A Credit Grant gives one subject an amount, or a monthly cap, between a start and an expiry, with who approved it and why. Usage is invoiced at full price, then the subject's grants offset it once, when the invoice is issued, soonest expiry first. A grant is never edited: a change is a new grant that supersedes the old one, so the history stays audited.
#Where it is served
Credits is served by Sylphx Money on the one API. Every call is
under https://api.sylphx.com/v1/orgs/{org}/projects/{project}/envs/{env}/
and takes a Sylphx key with the scope its method names in the API reference
(keys and scopes).
#The resources
| Collection | What it is |
|---|---|
| credit grants | A Credit Grant is credit a merchant gives a subject: audited, append-only, invoiced at full price and then offset once at invoice issue, soonest expiry first. |
Each link opens the collection's methods, with the path, scope, request, response and examples of every call. Credits offsets invoices of Payments usage billing.