Maxio Advanced Billing
HomeSDKsAPI ReferenceContext Plugin
Invoices

List Invoice Events

GET
/invoices/events.json

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.

Authorization

BasicAuth
AuthorizationBasic <token>

The username is a Maxio Chargify API key. The password is x.

In: header

Query Parameters

since_date?string

The timestamp in a format YYYY-MM-DD T HH:MM:SS Z, or YYYY-MM-DD(in this case, it returns data from the beginning of the day). of the event from which you want to start the search. All the events before the since_date timestamp are not returned in the response.

since_id?integer

The ID of the event from which you want to start the search(ID is not included. e.g. if ID is set to 2, then all events with ID 3 and more will be shown) This parameter is not used if since_date is defined.

Formatint64
page?integer

Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned. Use in query page=1.

Range1 <= value
Default1
per_page?integer

This parameter indicates how many records to fetch in each request. Default value is 100. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.

Default100
invoice_uid?string

Providing an invoice_uid allows for scoping of the invoice events to a single invoice or credit note.

with_change_invoice_status?string

Use this parameter if you want to fetch also invoice events with change_invoice_status type.

event_types?array<>

Filter results by event_type. Supply a comma separated list of event types (listed above). Use in query: event_types=void_invoice,void_remainder.

Response Body

application/json

curl -X GET "https://example.com/invoices/events.json"
{  "events": [    {      "id": 83,      "event_type": "apply_payment",      "event_data": {        "memo": "Non-Resumable Canceled On Purpose - Standard Plan: Renewal payment",        "original_amount": "168.61",        "applied_amount": "168.61",        "transaction_time": "2018-08-01T16:00:00Z",        "payment_method": {          "card_brand": "visa",          "card_expiration": "12/2022",          "last_four": null,          "masked_card_number": "XXXX-XXXX-XXXX-1111",          "type": "credit_card"        },        "consolidation_level": "none"      },      "timestamp": "2018-08-01T16:00:00Z",      "invoice": {        "id": 614942008934401500,        "uid": "inv_8gk5bwkct3gqt",        "site_id": 20,        "customer_id": 6,        "subscription_id": 10,        "number": "25",        "sequence_number": 25,        "transaction_time": "2018-08-01T16:00:00Z",        "created_at": "2018-08-01T16:00:00Z",        "updated_at": "2018-08-01T16:00:00Z",        "issue_date": "2018-08-01",        "due_date": "2018-08-01",        "paid_date": "2018-08-01",        "status": "paid",        "role": "renewal",        "collection_method": "automatic",        "payment_instructions": "Please make checks payable to \"Acme, Inc.\"",        "currency": "USD",        "consolidation_level": "none",        "parent_invoice_id": null,        "subscription_group_id": null,        "parent_invoice_number": null,        "product_name": "Standard Plan",        "product_family_name": "Cloud Compute Servers",        "seller": {          "name": "Acme, Inc.",          "address": {            "street": null,            "line2": null,            "city": null,            "state": null,            "zip": null,            "country": null          },          "phone": "555-555-1234 x137",          "logo_url": null        },        "customer": {          "chargify_id": 6,          "first_name": "Non-Resumable",          "last_name": "Canceled On Purpose",          "organization": null,          "email": "evan4@example.com"        },        "payer": {          "chargify_id": 6,          "first_name": "Non-Resumable",          "last_name": "Canceled On Purpose",          "organization": null,          "email": "evan4@example.com"        },        "net_terms": 0,        "memo": "Thanks for your business! If you have any questions, please contact your account manager.",        "billing_address": {          "street": "200 Billing Rd.",          "line2": "Suite 100",          "city": "Needham",          "state": "MA",          "zip": "02494",          "country": "US"        },        "shipping_address": {          "street": "100 Shipping St.",          "line2": "Apt 200",          "city": "Pleasantville",          "state": "NC",          "zip": "12345",          "country": "US"        },        "line_items": [          {            "uid": "li_8gk5bwkct3gqk",            "title": "Standard Plan",            "description": "08/01/2018 - 09/01/2018",            "quantity": "1.0",            "unit_price": "99.0",            "subtotal_amount": "99.0",            "discount_amount": "9.9",            "tax_amount": "6.01425",            "tax_included": false,            "total_amount": "95.11425",            "tiered_unit_price": false,            "period_range_start": "2018-08-01",            "period_range_end": "2018-09-01",            "transaction_id": 120,            "product_id": 84,            "product_version": 1,            "component_id": null,            "price_point_id": null,            "hide": false          },          {            "uid": "li_8gk5bwkct3gqm",            "title": "Small Instance (Hourly)",            "description": "07/22/2018 - 08/01/2018",            "quantity": "162.0",            "unit_price": "0.09567901",            "subtotal_amount": "15.5",            "discount_amount": "1.55",            "tax_amount": "0.941625",            "tax_included": false,            "total_amount": "14.891625",            "tiered_unit_price": true,            "period_range_start": "2018-07-22",            "period_range_end": "2018-08-01",            "transaction_id": 121,            "product_id": 84,            "product_version": 1,            "component_id": 76,            "price_point_id": null,            "hide": false,            "component_cost_data": {              "rates": [                {                  "component_code_id": null,                  "price_point_id": 160,                  "product_id": 84,                  "quantity": "162.0",                  "amount": "15.5",                  "pricing_scheme": "tiered",                  "tiers": [                    {                      "starting_quantity": 1,                      "ending_quantity": 100,                      "quantity": "100.0",                      "unit_price": "0.0",                      "amount": "0.0"                    },                    {                      "starting_quantity": 101,                      "ending_quantity": null,                      "quantity": "62.0",                      "unit_price": "0.25",                      "amount": "15.5"                    }                  ]                }              ]            }          },          {            "uid": "li_8gk5bwkct3gqn",            "title": "Large Instance (Hourly)",            "description": "07/22/2018 - 08/01/2018",            "quantity": "194.0",            "unit_price": "0.24226804",            "subtotal_amount": "47.0",            "discount_amount": "4.7",            "tax_amount": "2.85525",            "tax_included": false,            "total_amount": "45.15525",            "tiered_unit_price": true,            "period_range_start": "2018-07-22",            "period_range_end": "2018-08-01",            "transaction_id": 122,            "product_id": 84,            "product_version": 1,            "component_id": 77,            "price_point_id": null,            "hide": false,            "component_cost_data": {              "rates": [                {                  "component_code_id": null,                  "price_point_id": 161,                  "product_id": 84,                  "quantity": "194.0",                  "amount": "47.0",                  "pricing_scheme": "tiered",                  "tiers": [                    {                      "starting_quantity": 1,                      "ending_quantity": 100,                      "quantity": "100.0",                      "unit_price": "0.0",                      "amount": "0.0"                    },                    {                      "starting_quantity": 101,                      "ending_quantity": null,                      "quantity": "94.0",                      "unit_price": "0.5",                      "amount": "47.0"                    }                  ]                }              ]            }          },          {            "uid": "li_8gk5bwkct3gqp",            "title": "IP Addresses",            "description": "08/01/2018 - 09/01/2018",            "quantity": "7.0",            "unit_price": "2.0",            "subtotal_amount": "14.0",            "discount_amount": "1.4",            "tax_amount": "0.8505",            "tax_included": false,            "total_amount": "13.4505",            "tiered_unit_price": false,            "period_range_start": "2018-08-01",            "period_range_end": "2018-09-01",            "transaction_id": 123,            "product_id": 84,            "product_version": 1,            "component_id": 79,            "price_point_id": 163,            "hide": false,            "component_cost_data": {              "rates": [                {                  "component_code_id": null,                  "price_point_id": 163,                  "product_id": 84,                  "quantity": "7.0",                  "amount": "14.0",                  "pricing_scheme": "per_unit",                  "tiers": [                    {                      "starting_quantity": 1,                      "ending_quantity": null,                      "quantity": "7.0",                      "unit_price": "2.0",                      "amount": "14.0"                    }                  ]                }              ]            }          }        ],        "subtotal_amount": "175.5",        "discount_amount": "17.55",        "discounts": [          {            "uid": "dli_8gk5bwkct3gqq",            "title": "Multi-service discount (10%)",            "description": null,            "code": "MULTI3",            "source_type": "Coupon",            "source_id": 40,            "discount_type": "percentage",            "percentage": "10.0",            "eligible_amount": "175.5",            "discount_amount": "17.55",            "transaction_id": 124,            "line_item_breakouts": [              {                "uid": "li_8gk5bwkct3gqk",                "eligible_amount": "99.0",                "discount_amount": "9.9"              },              {                "uid": "li_8gk5bwkct3gqm",                "eligible_amount": "15.5",                "discount_amount": "1.55"              },              {                "uid": "li_8gk5bwkct3gqn",                "eligible_amount": "47.0",                "discount_amount": "4.7"              },              {                "uid": "li_8gk5bwkct3gqp",                "eligible_amount": "14.0",                "discount_amount": "1.4"              }            ]          }        ],        "tax_amount": "10.66",        "taxes": [          {            "uid": "tli_8gk5bwkct3gqr",            "title": "NC Sales Tax",            "description": null,            "source_type": "Tax",            "source_id": 1,            "percentage": "6.75",            "taxable_amount": "157.95",            "tax_amount": "10.66",            "transaction_id": 125,            "line_item_breakouts": [              {                "uid": "li_8gk5bwkct3gqk",                "taxable_amount": "89.1",                "tax_amount": "6.01425"              },              {                "uid": "li_8gk5bwkct3gqm",                "taxable_amount": "13.95",                "tax_amount": "0.941625"              },              {                "uid": "li_8gk5bwkct3gqn",                "taxable_amount": "42.3",                "tax_amount": "2.85525"              },              {                "uid": "li_8gk5bwkct3gqp",                "taxable_amount": "12.6",                "tax_amount": "0.8505"              }            ],            "tax_component_breakouts": [              {                "tax_rule_id": 1,                "percentage": "6.75",                "country_code": "US",                "subdivision_code": "NC",                "tax_amount": "10.66",                "taxable_amount": "157.95",                "tax_exempt_amount": "0.0",                "non_taxable_amount": "0.0",                "tax_name": "NC STATE TAX",                "tax_type": "Sales",                "rate_type": "General",                "tax_authority_type": 45,                "state_assigned_no": "",                "tax_sub_type": "S"              }            ],            "eu_vat": false,            "type": "Sales",            "tax_exempt_amount": "0.0"          }        ],        "credit_amount": "0.0",        "refund_amount": "0.0",        "total_amount": "168.61",        "paid_amount": "168.61",        "due_amount": "0.0",        "payments": [          {            "memo": "Non-Resumable Canceled On Purpose - Standard Plan: Renewal payment",            "original_amount": "168.61",            "applied_amount": "168.61",            "transaction_time": "2018-08-01T16:00:00Z",            "payment_method": {              "card_brand": "visa",              "card_expiration": "12/2022",              "last_four": null,              "masked_card_number": "XXXX-XXXX-XXXX-1111",              "type": "credit_card"            },            "transaction_id": 126,            "prepayment": false          }        ],        "display_settings": {          "hide_zero_subtotal_lines": false,          "include_discounts_on_lines": false        }      }    }  ],  "page": 48,  "per_page": 1,  "total_pages": 102}

Read Invoice GET

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: ```curl -u <api_key>:x -H Accept:application/pdf -H https://acme.chargify.com/invoices/inv_8gd8tdhtd3hgr.pdf > output_file.pdf URL: `https://<subdomain>.chargify.com/invoices/<uid>.<format>` Method: GET Required parameters: `uid` Response: A single Invoice. ```

Record Payment for Invoice POST

Applies a payment of a given type against a specific invoice. If you would like to apply a payment across multiple invoices, you can use the [Record Payment for Multiple Invoices](https://maxio-test-wp.pages.dev/api/openapi/invoices/recordPaymentForMultipleInvoices) endpoint.