Read Invoice
Returns the details for an invoice.
PDF Invoice retrieval
Individual PDF Invoices can be retrieved by using the "Accept" header application/pdf or appending .pdf as the format portion of the URL:
Accept:application/pdf -Hhttps://acme.chargify.com/invoices/inv_8gd8tdhtd3hgr.pdf > output_file.pdfURL: `https://<subdomain>.chargify.com/invoices/<uid>.<format>`Method: GETRequired parameters: `uid`Response: A single Invoice.Authorization
BasicAuth The username is a Maxio Chargify API key. The password is x.
In: header
Path Parameters
The unique identifier for the invoice, this does not refer to the public facing invoice number.
Response Body
application/json
curl -X GET "https://example.com/invoices/string.json"{ "uid": "inv_8gd8tdhtd3hgr", "site_id": 51288, "customer_id": 20194505, "subscription_id": 20597774, "number": "117", "sequence_number": 117, "issue_date": "2018-07-26", "due_date": "2018-07-26", "paid_date": "2018-07-26", "status": "paid", "collection_method": "automatic", "payment_instructions": "Make checks payable to Acme, Inc.", "currency": "USD", "consolidation_level": "none", "parent_invoice_uid": null, "parent_invoice_number": null, "group_primary_subscription_id": null, "product_name": "Monthly Product", "product_family_name": "Billing Plans", "seller": { "name": "General Goods", "address": { "street": "123 General Goods Way", "line2": "Apt. 10", "city": "Boston", "state": "MA", "zip": "02120", "country": "US" }, "phone": "555-555-1212" }, "customer": { "chargify_id": 20194505, "first_name": "Joe", "last_name": "Example", "organization": null, "email": "joe@example.com" }, "memo": "Payment due within 15 days of receipt.", "billing_address": { "street": null, "line2": null, "city": null, "state": null, "zip": null, "country": null }, "shipping_address": { "street": null, "line2": null, "city": null, "state": null, "zip": null, "country": null }, "subtotal_amount": "100.0", "discount_amount": "0.0", "tax_amount": "0.0", "total_amount": "100.0", "credit_amount": "0.0", "paid_amount": "100.0", "refund_amount": "0.0", "due_amount": "0.0", "line_items": [ { "uid": "li_8gd8tdhhgk55k", "title": "Monthly Product", "description": "Jul 26, 2018 - Aug 26, 2018", "quantity": "1.0", "unit_price": "100.0", "subtotal_amount": "100.0", "discount_amount": "0.0", "tax_amount": "0.0", "tax_included": false, "total_amount": "100.0", "tiered_unit_price": false, "period_range_start": "2018-07-26", "period_range_end": "2018-08-26", "product_id": 4607632, "product_version": 1, "component_id": null, "price_point_id": null } ], "payments": [ { "transaction_time": "2018-07-26T15:22:02Z", "memo": "Joe Example - Monthly Product: Renewal payment", "original_amount": "100.0", "applied_amount": "100.0", "payment_method": { "card_brand": "bogus", "card_expiration": "10/2020", "last_four": null, "masked_card_number": "XXXX-XXXX-XXXX-1", "type": "credit_card" }, "transaction_id": 253028955, "prepayment": false, "received_on": "2018-07-26" } ], "public_url": "https://www.chargifypay.com/invoice/inv_8jzrw74xq8kxr?token=fb6kpjz5rcr2vttyjs4rcv6y"}List Invoices GET
Lists invoices for a site. By default, invoices returned on the index will only include totals, not detailed breakdowns for `line_items`, `discounts`, `taxes`, `credits`, `payments`, `custom_fields`, or `refunds`. To include breakdowns, pass the specific field as a key in the query with a value set to `true`.
List Invoice Events GET
Lists invoice events for a site. Each event contains event "data" (such as an applied payment) as well as a snapshot of the `invoice` at the time of event completion. Exposed event types are: + issue_invoice + apply_credit_note + apply_payment + refund_invoice + void_invoice + void_remainder + backport_invoice + change_invoice_status + change_invoice_collection_method + remove_payment + failed_payment + apply_debit_note + create_debit_note + change_chargeback_status Invoice events are returned in ascending order. If both a `since_date` and `since_id` are provided in request parameters, the `since_date` will be used. Note - invoice events that occurred prior to 09/05/2018 __will not__ contain an `invoice` snapshot.