Escalations
Raised when a customer asks for help, disputes an invoice, requests a human, or refuses to pay. Created by Chargetree's own communications, not by you, so this resource is read-only.
/escalations/{id}Returns a single escalation. Escalations are raised by Chargetree's own communications when a customer asks for help, disputes an invoice, asks to speak to a person, or refuses to pay, so there is no way to create one through the API.
You will usually reach this endpoint from the resource_url on an
escalation.created or escalation.resolved webhook.
Authorization
accountKey An account API key, in the form ct_live_ followed by 32 characters.
Generate one in the Chargetree dashboard under Settings → API. The
plaintext key is shown only once.
Send it as Authorization: Bearer ct_live_....
In: header
Path Parameters
The escalation's identifier.
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/escalations/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65", "invoice_id": "f4c4edb8-11e0-4b33-bcc1-482dc59ebb32", "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598", "escalation_type": "hardship", "priority": "high", "status": "string", "trigger_channel": "email", "customer_statement": "string", "resolution_outcome": "string", "resolution_notes": "string", "resolved_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}Contacts
The people and companies you invoice. Contacts are matched rather than blindly duplicated: supply an `id`, `external_id` or `email` and Chargetree reuses the existing record where it can.
Invoices
Raise, amend, send and cancel invoices. Invoices move through the statuses `DRAFT`, `SCHEDULED`, `UNPAID`, `OVERDUE`, `PARTIALLY_PAID`, `PAID` and `CANCELLED`.