Expanding Objects

Sometimes, Hint objects contain attributes of other related Hint objects that you may want access to. Currently, the only applies to CustomerInvoice, and Company. For example, Customer invoices contain many Charges. And by default, CustomerInvoices do not show you all details of all charges. However, you can 'expand' the charges attribute on CustomerInvoice objects to ask for the full details.

If an object has expandable attributes, they will be noted on that object's API reference page.

Example expansion request:

curl https://api.staging.hint.com/api/provider/customer_invoices/inv-4IklwJi23xQ?expand=charges

๐Ÿ“˜

Webhooks will always contain the unexpanded version.


Did this page help you?