Skip to main content

External Key Examples

Adding external_key values to ChargeOver enables several "short-cuts" when working with the ChargeOver REST API.

  • You can get objects from ChargeOver by external_key instead of using the customer_id, item_id, etc.

  • When adding or updating objects, you can reference other objects by *_external_key instead of their *_id values

API EXAMPLES
// Get a customer with external_key = abc123
GET /api/v3/customer/external_key:abc123


// Add an invoice for the customer with external_key = abc123
POST /api/v3/invoice

{
    "customer_external_key": "abc123",
    ... other invoice data here ...
}