Credits and commits
List credits
Retrieve a detailed list of all credits available to a customer, including promotional credits and contract-specific credits. This endpoint provides comprehensive visibility into credit balances, access schedules, and usage rules, enabling you to build credit management interfaces and track available funding.
Use this endpoint to:
- Display all available credits in customer billing dashboards
- Show credit balances and expiration dates
- Track credit usage history with optional ledger details
- Build credit management and reporting tools
- Monitor promotional credit utilization • Support customer inquiries about available credits
Key response fields:
An array of Credit objects containing:
- Credit details: Name, priority, and which applicable products/tags it applies to
- Product ID: The
product_idof the credit. This is for external mapping into your quote-to-cash stack, not the product it applies to. - Access schedule: When credits become available and expire
- Optional ledger entries: Transaction history (if
include_ledgers=true) - Balance information: Current available amount (if
include_balance=true) - Metadata: Custom fields and usage specifiers
Usage guidelines:
- Pagination: Results limited to 25 commits per page; use next_page for more
- Date filtering options:
covering_date: Credits active on a specific datestarting_at: Credits with access on/after a dateeffective_before: Credits with access before a date (exclusive)
- Scope options:
include_contract_credits: Include contract-level credits (not just customer-level)include_archived: Include archived credits and credits from archived contracts
- Performance considerations:
include_ledgers: Adds detailed transaction history (slower)include_balance: Adds current balance calculation (slower)
- Optional filtering: Use credit_id to retrieve a specific commit
POST
List credits
Authorizations
Body
application/json
List all credits for a customer