About Us
Metadata
Metadata allows you to store custom key-value pairs on Charge API objects. Use metadata to persist information that’s not part of the core API schema.
How It Works
Metadata is a flexible object that accepts any key-value pairs. All metadata keys and values are stored as strings.
Supported Objects
Metadata is available on these Charge API objects:
- Accounts - Organization details, preferences
- Fleets - Fleet-specific information, regions
- Drivers - Driver preferences, notes, tags
- Vehicles - Vehicle details, maintenance info
- Charging Sessions - Session notes, purpose
- Payment Methods - Payment preferences, notes
- Invoices - Billing notes, cost centers
- Webhook Endpoints - Integration details
Common Use Cases
Fleet Management
Driver Information
Vehicle Tracking
Charging Session Notes
Limits
- Maximum keys: 50 per object
- Key length: 40 characters maximum
- Value length: 500 characters maximum
- Total size: 20KB maximum
Searching and Filtering
List with Metadata Filter
Sensitive Information
Don’t store sensitive data like passwords, API keys, or PII in metadata. Use secure storage for confidential information.