List Invoices

GET https://api.chartmogul.com/v1/invoices

Returns a list of invoice objects created using the API in your ChartMogul account.

curl -X GET "https://api.chartmogul.com/v1/invoices?customer_uuid=cus_f466e33d-ff2b-4a11-8f85-417eb02157a7&external_id=inv_0001" \
     -u YOUR_API_KEY: \
     -H "Content-Type: application/json"

ChartMogul::Invoices.all(
  customer_uuid: "cus_f466e33d-ff2b-4a11-8f85-417eb02157a7",
  external_id: "inv_0001",
)

ChartMogul.Invoice.all(config, {
  customer_uuid: "cus_f466e33d-ff2b-4a11-8f85-417eb02157a7",
  external_id: "inv_0001",
});

ChartMogul\Invoice::all([
  "customer_uuid" => "cus_f466e33d-ff2b-4a11-8f85-417eb02157a7",
  "external_id" => "inv_0001"
]);

api.ListAllInvoices(&cm.ListAllInvoicesParams{
  CustomerUUID: "cus_f466e33d-ff2b-4a11-8f85-417eb02157a7",
  ExternalID:   "inv_0001",
})

chartmogul.Invoice.all(
  config,
  customer_uuid="cus_f466e33d-ff2b-4a11-8f85-417eb02157a7",
  external_id="inv_0001",
)

{
  "invoices": [
    {
      "uuid": "inv_565c73b2-85b9-49c9-a25e-2b7df6a677c9",
      "customer_uuid": "cus_f466e33d-ff2b-4a11-8f85-417eb02157a7",
      "external_id": "inv_0001",
      "date": "2022-11-01T00:00:00.000Z",
      "due_date": "2022-11-15T00:00:00.000Z",
      "currency": "USD",
      "customer_external_id": "cus_RD2Qm9lIVdoAp6",
      "collection_method": "manual",
      "status": "paid",
      "errors":
      {},
      "disabled": false,
      "disabled_at": null,
      "disabled_by": null,
      "user_created": false,
      "edit_history_summary":
      {},
      "line_items": [
        {
          "uuid": "li_d72e6843-5793-41d0-bfdf-0269514c9c56",
          "external_id": null,
          "type": "subscription",
          "amount_in_cents": 5000,
          "quantity": 1,
          "discount_code": "PSO86",
          "discount_amount_in_cents": 1000,
          "tax_amount_in_cents": 900,
          "transaction_fees_in_cents": 200,
          "account_code": null,
          "plan_uuid": "pl_eed05d54-75b4-431b-adb2-eb6b9e543206",
          "plan_external_id": "gold_plan",
          "transaction_fees_currency": "USD",
          "discount_description": "New signup promo",
          "event_order": 5,
          "balance_transfer": false,
          "subscription_uuid": "sub_e6bc5407-e258-4de0-bb43-61faaf062035",
          "subscription_external_id": "sub_0001",
          "prorated": false,
          "proration_type": "full",
          "service_period_start": "2022-11-01T00:00:00.000Z",
          "service_period_end": "2022-12-01T00:00:00.000Z",
          "subscription_set_external_id": "set_0001",
          "disabled": false,
          "disabled_at": null,
          "disabled_by": null,
          "user_created": false,
          "edit_history_summary":
          {}
        },
        {
          "uuid": "li_0cc8c112-beac-416d-af11-f35744ca4e83",
          "external_id": null,
          "type": "one_time",
          "amount_in_cents": 2500,
          "quantity": 1,
          "discount_code": "PSO86",
          "discount_amount_in_cents": 500,
          "tax_amount_in_cents": 450,
          "transaction_fees_in_cents": 0,
          "transaction_fees_currency": "USD",
          "discount_description": "New signup promo",
          "description": "Setup Fees",
          "disabled": false,
          "disabled_at": null,
          "disabled_by": null,
          "user_created": false,
          "edit_history_summary":
          {}
        }
      ],
      "transactions": [
        {
          "uuid": "tr_879d560a-1bec-41bb-986e-665e38a2f7bc",
          "external_id": null,
          "type": "payment",
          "date": "2022-11-05T00:14:23.000Z",
          "result": "successful",
          "amount_in_cents": null,
          "transaction_fees_in_cents": 350,
          "transaction_fees_currency": "EUR",
          "disabled": false,
          "disabled_at": null,
          "disabled_by": null,
          "user_created": false,
          "edit_history_summary":
          {}
        }
      ]
    }
  ],
  "current_page": 1, // deprecated
  "total_pages": 1, // deprecated
  "cursor": "AjMx90kC0yMVQwNNwoYToyNC4wMDAwMDAwMDBgks68k",
  "has_more": false
}

#<ChartMogul::Invoices:0x007fb49884b850
  @invoices=[
    #<ChartMogul::Invoice:0x007fb498a04660 
      @uuid="inv_565c73b2-85b9-49c9-a25e-2b7df6a677c9",
      @customer_uuid="cus_f466e33d-ff2b-4a11-8f85-417eb02157a7",
      @date=2022-11-01 00:00:00 UTC, 
      @currency="USD", 
      @external_id="inv_0001", 
      @due_date=2022-11-15 00:00:00 UTC, 
      @line_items=[
        #<ChartMogul::LineItems::Subscription:0x007fb4994d23f8 
        @uuid="li_d72e6843-5793-41d0-bfdf-0269514c9c56",
        @external_id=nil, 
        @type="subscription",
        @subscription_uuid="sub_e6bc5407-e258-4de0-bb43-61faaf062035", 
        @subscription_external_id="sub_0001",
        @subscription_set_external_id="set_0001",
        @plan_uuid="pl_eed05d54-75b4-431b-adb2-eb6b9e543206", 
        @service_period_start=2022-11-01 00:00:00 UTC, 
        @service_period_end=2022-12-01 00:00:00 UTC, 
        @amount_in_cents=5000, 
        @quantity=1, 
        @discount_code="PSO86",
        @discount_amount_in_cents=1000,
        @tax_amount_in_cents=900,
        @transaction_fees_in_cents=200,
        @cancelled_at=nil,
        @prorated=false,
        @invoice_uuid="inv_565c73b2-85b9-49c9-a25e-2b7df6a677c9",
        @transaction_fees_currency="USD",
        @discount_description="New signup promo",
        @event_order=5,
        @account_code=nil
        >,
        #<ChartMogul::LineItems::OneTime:0x007fb499149358 
        @uuid="li_0cc8c112-beac-416d-af11-f35744ca4e83",
        @external_id=nil,
        @type="one_time",
        @amount_in_cents=2500, 
        @description="Setup Fees", 
        @quantity=1, 
        @discount_amount_in_cents=500, 
        @discount_code="PSO86", 
        @tax_amount_in_cents=450,
        @transaction_fees_in_cents=0,
        @invoice_uuid="inv_565c73b2-85b9-49c9-a25e-2b7df6a677c9",
        @transaction_fees_currency="USD",
        @discount_description="New signup promo",
        @account_code=nil
        >,
      ], 
      @transactions=[
        #<ChartMogul::Transactions::Payment:0x007fb4991013f0 
        @uuid="tr_879d560a-1bec-41bb-986e-665e38a2f7bc",
        @external_id=nil,
        @date=2022-11-05 14:23:00 UTC, 
        @result="successful", 
        @type="payment",
        @invoice_uuid="inv_565c73b2-85b9-49c9-a25e-2b7df6a677c9"
        >,
      ]
    >,
  ],
  @current_page=1, # deprecated with version 4.0.0
  @total_pages=1, # deprecated with version 4.0.0
  @cursor="AjMx90kC0yMVQwNNwoYToyNC4wMDAwMDAwMDBgks68k",
  @has_more=false
>

{
  invoices: [
    {
      uuid: "inv_565c73b2-85b9-49c9-a25e-2b7df6a677c9",
      customer_uuid: "cus_f466e33d-ff2b-4a11-8f85-417eb02157a7",
      external_id: "inv_0001",
      date: "2022-11-01T00:00:00.000Z",
      due_date: "2022-11-15T00:00:00.000Z",
      currency: "USD",
      line_items: [
        {
          uuid: "li_d72e6843-5793-41d0-bfdf-0269514c9c56",
          external_id: null,
          type: "subscription",
          subscription_uuid: "sub_e6bc5407-e258-4de0-bb43-61faaf062035",
          subscription_external_id: "sub_0001",
          subscription_set_external_id: "set_0001",
          plan_uuid: "pl_eed05d54-75b4-431b-adb2-eb6b9e543206",
          prorated: false,
          service_period_start: "2022-11-01T00:00:00.000Z",
          service_period_end: "2022-12-01T00:00:00.000Z",
          amount_in_cents: 5000,
          quantity: 1,
          discount_code: "PSO86",
          discount_amount_in_cents: 1000,
          tax_amount_in_cents: 900,
          transaction_fees_in_cents: 200,
          transaction_fees_currency: "USD",
          discount_description: "New signup promo",
          event_order: 5,
          account_code: null
        },
        {
          uuid: "li_0cc8c112-beac-416d-af11-f35744ca4e83",
          external_id: null,
          type: "one_time",
          description: "Setup Fees",
          amount_in_cents: 2500,
          quantity: 1,
          discount_code: "PSO86",
          discount_amount_in_cents: 500,
          tax_amount_in_cents: 450,
          transaction_fees_in_cents: 0,
          transaction_fees_currency: "USD",
          discount_description: "New signup promo",
          account_code: null
        }
      ],
      transactions: [
        {
          uuid: "tr_879d560a-1bec-41bb-986e-665e38a2f7bc",
          external_id: null,
          type: "payment",
          date: "2022-11-05T00:14:23.000Z",
          result: "successful"
        }
      ]
    }
  ],
  current_page: 1, // deprecated with version 3.0.0
  total_pages: 2, // deprecated with version 3.0.0
  cursor: "AjMx90kC0yMVQwNNwoYToyNC4wMDAwMDAwMDBgks68k",
  has_more: false
}

Doctrine\Common\Collections\ArrayCollection::__set_state(array(
  "elements" => array (
    0 => ChartMogul\Invoice::__set_state(array(
      "uuid" => "inv_565c73b2-85b9-49c9-a25e-2b7df6a677c9",
      "customer_uuid" => "cus_f466e33d-ff2b-4a11-8f85-417eb02157a7",
      "date" => "2022-11-01T00:00:00.000Z",
      "currency" => "USD",
      "line_items" => Doctrine\Common\Collections\ArrayCollection::__set_state(array(
        "elements" => array (
          0 => ChartMogul\LineItems\Subscription::__set_state(array(
            "type" => "subscription",
            "subscription_external_id" => "sub_0001",
            "subscription_set_external_id" => "set_0001",
            "service_period_start" => "2022-11-01T00:00:00.000Z",
            "service_period_end" => "2022-12-01T00:00:00.000Z",
            "cancelled_at" => NULL,
            "prorated" => false,
            "subscription_uuid" => "sub_e6bc5407-e258-4de0-bb43-61faaf062035",
            "plan_uuid" => "pl_eed05d54-75b4-431b-adb2-eb6b9e543206",
            "uuid" => "li_d72e6843-5793-41d0-bfdf-0269514c9c56",
            "amount_in_cents" => 5000,
            "quantity" => 1,
            "discount_amount_in_cents" => 1000,
            "discount_code" => "PSO86",
            "tax_amount_in_cents" => 900,
            "transaction_fees_in_cents" => 200,
            "external_id" => NULL,
            "invoice_uuid" => NULL,
            "transaction_fees_currency" => "USD",
            "discount_description" => "New signup promo",
            "event_order" => 5,
            "account_code" => NULL
          )),
          1 => ChartMogul\LineItems\OneTime::__set_state(array(
            "type" => "one_time",
            "description" => "Setup Fees",
            "uuid" => "li_0cc8c112-beac-416d-af11-f35744ca4e83",
            "amount_in_cents" => 2500,
            "quantity" => 1,
            "discount_amount_in_cents" => 500,
            "discount_code" => "PSO86",
            "tax_amount_in_cents" => 450,
            "transaction_fees_in_cents" => 0,
            "external_id" => NULL,
            "invoice_uuid" => NULL,
            "transaction_fees_currency" => "USD",
            "discount_description" => "New signup promo",
            "account_code" => NULL
          )),
        ),
      )),
      "transactions" => Doctrine\Common\Collections\ArrayCollection::__set_state(array(
        "elements" => array (
          0 => ChartMogul\Transactions\Payment::__set_state(array(
            "type" => "payment",
            "uuid" => "tr_879d560a-1bec-41bb-986e-665e38a2f7bc",
            "date" => "2022-11-05T00:14:23.000Z",
            "result" => "successful",
            "external_id" => NULL,
            "invoice_uuid" => NULL,
          )),
        ),
      )),
      "external_id" => "inv_0001",
      "due_date" => "2022-11-15T00:00:00.000Z",
    )),
  ),
  "current_page" => 1, # deprecated with version 6.0.0
  "total_pages" => 2, # deprecated with version 6.0.0
  "cursor" => "AjMx90kC0yMVQwNNwoYToyNC4wMDAwMDAwMDBgks68k",
  "has_more" => false
))

(*chartmogul.Invoices)(0xc042116400)({
  CustomerUUID: (string) "",
  TotalPages: (uint32) 1, // deprecated with version v4
  CurrentPage: (uint32) 1, // deprecated with version v4
  Cursor: (string) (len=44) "AjMx90kC0yMVQwNNwoYToyNC4wMDAwMDAwMDBgks68k",
  HasMore: (bool) false,
  Error: (string) "",
  Invoices: ([]*chartmogul.Invoice) (len=1 cap=4) {
    (*chartmogul.Invoice)(0xc0420f0320)({
      UUID: (string) (len=40) "inv_565c73b2-85b9-49c9-a25e-2b7df6a677c9",
      CustomerUUID: (string) (len=40) "cus_f466e33d-ff2b-4a11-8f85-417eb02157a7",
      Currency: (string) (len=3) "USD",
      Date: (string) (len=24) "2022-11-01T00:00:00.000Z",
      DueDate: (string) (len=24) "2022-11-15T00:00:00.000Z",
      ExternalID: (string) (len=7) "inv_0001",
      LineItems: ([]*chartmogul.LineItem) (len=2 cap=4) {
      (*chartmogul.LineItem)(0xc0420e60f0)({
        UUID: (string) (len=39) "li_d72e6843-5793-41d0-bfdf-0269514c9c56",
        AccountCode: (string) "",
        AmountInCents: (int) 5000,
        CancelledAt: (string) "",
        Description: (string) "",
        DiscountAmountInCents: (int) 1000,
        DiscountCode: (string) (len=5) "PSO86",
        ExternalID: (string) "",
        PlanUUID: (string) (len=39) "pl_eed05d54-75b4-431b-adb2-eb6b9e543206",
        Prorated: (bool) false,
        Quantity: (int) 1,
        ServicePeriodEnd: (string) (len=24) "2022-12-01T00:00:00.000Z",
        ServicePeriodStart: (string) (len=24) "2022-11-01T00:00:00.000Z",
        SubscriptionExternalID: (string) "sub_0001",
        SubscriptionSetExternalID: (string) (len=8) "set_0001",
        SubscriptionUUID: (string) (len=40) "sub_e6bc5407-e258-4de0-bb43-61faaf062035",
        TaxAmountInCents: (int) 900,
        TransactionFeesInCents: (int) 200,
        TransactionFeesCurrency: (string) "USD",
        DiscountDescription: (string) "New signup promo",
        EventOrder: (int) 5,
        Type: (string) (len=12) "subscription"
      }),
      (*chartmogul.LineItem)(0xc0420e61e0)({
        UUID: (string) (len=39) "li_0cc8c112-beac-416d-af11-f35744ca4e83",
        AccountCode: (string) "",
        AmountInCents: (int) 2500,
        CancelledAt: (string) "",
        Description: (string) (len=10) "Setup Fees",
        DiscountAmountInCents: (int) 500,
        DiscountCode: (string) (len=5) "PSO86",
        ExternalID: (string) "",
        PlanUUID: (string) "",
        Prorated: (bool) false,
        Quantity: (int) 1,
        ServicePeriodEnd: (string) "",
        ServicePeriodStart: (string) "",
        SubscriptionExternalID: (string) "",
        SubscriptionUUID: (string) "",
        TaxAmountInCents: (int) 450,
        TransactionFeesInCents: (int) 0,
        TransactionFeesCurrency: (string) "USD",
        DiscountDescription: (string) "New signup promo",
        Type: (string) (len=8) "one_time"
      })
      },
      Transactions: ([]*chartmogul.Transaction) (len=1 cap=4) {
      (*chartmogul.Transaction)(0xc04200fc80)({
        UUID: (string) (len=39) "tr_879d560a-1bec-41bb-986e-665e38a2f7bc",
        Date: (string) (len=24) "2022-11-05T00:14:23.000Z",
        ExternalID: (string) "",
        Result: (string) (len=10) "successful",
        Type: (string) (len=7) "payment",
        Errors: (chartmogul.Errors) chartmogul: map[]
      })
      },
      Errors: (*chartmogul.Errors)(<nil>)
    })
  }
})

Invoices(
  invoices=[
    <Invoice{currency="USD",
      customer_uuid="cus_f466e33d-ff2b-4a11-8f85-417eb02157a7",
      date=datetime.datetime(2022, 11, 1, 0, 0, tzinfo=tzutc()),
      due_date=datetime.datetime(2022, 11, 15, 0, 0, tzinfo=tzutc()),
      external_id="inv_0001",
      line_items=[
        <LineItem{account_code=None,
          amount_in_cents=5000,
          discount_amount_in_cents=1000,
          discount_code="PSO86",
          external_id=None,
          plan_uuid="pl_eed05d54-75b4-431b-adb2-eb6b9e543206",
          prorated=False,
          quantity=1,
          service_period_end=datetime.datetime(2022, 12, 1, 0, 0, tzinfo=tzutc()),
          service_period_start=datetime.datetime(2022, 11, 1, 0, 0, tzinfo=tzutc()),
          subscription_uuid="sub_e6bc5407-e258-4de0-bb43-61faaf062035",
          subscription_external_id="sub_0001",
          subscription_set_external_id="set_0001",
          tax_amount_in_cents=900,
          transaction_fees_in_cents=200,
          transaction_fees_currency="USD",
          discount_description="New signup promo",
          event_order=5,
          type="subscription",
          uuid="li_d72e6843-5793-41d0-bfdf-0269514c9c56"
        }>,
        <LineItem{account_code=None,
          amount_in_cents=2500,
          discount_amount_in_cents=500,
          discount_code="PSO86",
          external_id=None,
          quantity=1,
          tax_amount_in_cents=450,
          transaction_fees_in_cents=0,
          transaction_fees_currency="USD",
          discount_description="New signup promo",
          type="one_time",
          uuid="li_0cc8c112-beac-416d-af11-f35744ca4e83"
        }>
      ],
      transactions=[
        <Transaction{date=datetime.datetime(2022, 11, 5, 0, 14, 23, tzinfo=tzutc()),
          external_id=None,
          result="successful",
          type="payment",
          uuid="tr_879d560a-1bec-41bb-986e-665e38a2f7bc"
        }>
      ],
      uuid="inv_565c73b2-85b9-49c9-a25e-2b7df6a677c9"
    }>
  ],
  current_page=1,  # deprecated with version 4.0.0
  total_pages=1,  # deprecated with version 4.0.0
  cursor="AjMx90kC0yMVQwNNwoYToyNC4wMDAwMDAwMDBgks68k",
  has_more=False,
  customer_uuid=None
)

Behavior with different types of sources. For automatic sources like Stripe, Chargebee, Recurly and Braintree (the latest version of the integration), we now permanently store all records added, edited or disabled using the API. Such edits are preserved after customer resyncs and automatic updates.

For these sources, use the include_edit_histories query parameter when retrieving or listing invoices to fetch both the original values imported from the billing system and the edited values. The with_disabled query parameter allows you to include disabled records in the response.

For other automatic sources, edits done via the API may be overwritten during customer resyncs or automatic updates.

For custom sources, edits are not stored separately from the original data.

Query parameters

data_source_uuid string optional: The ChartMogul UUID of the data source with which you want to filter this invoice list.
customer_uuid string optional: The ChartMogul UUID of the customer whose invoices you want to retrieve.
external_id string optional: A unique external identifier of the invoice that you want to retrieve.
per_page int32 optional default: 200: A limit on number of invoices to return per page. The default and maximum value is 200.
validation_type string optional default: "valid": Optional. The validation_type of the invoices to be retrieved, accepts the following values: 'valid', 'invalid' and 'all'. Based on this value returns valid/invalid/valid and invalid invoices. The default value is 'valid'.
include_edit_historiesboolean optional optional default: "false": Specifies whether the response should contain the edit_history_summary object with a summary of user edits for automatic sources like Stripe, Recurly, Chargebee or Braintree.
with_disabledboolean optional default: false: Specifies whether the response should contain disabled invoice.
page int32 optional default: 1 deprecated: The page number for pagination of results.
cursor string optional: A value that fetches the next page of Invoices. To fetch the next page of Customer's Invoices, set cursor to the value received in the previous page response.

Response

In the response, invoices contains an array of invoice objects with the following data:

uuid

The UUID of the invoice object generated by ChartMogul.

customer_uuid

The UUID of the customer that the invoice belongs to.

external_id

The unique external identifier for this invoice, as specified by you.

date

The date on which this invoice was raised, as specified by you.

due_date

The date by which this invoice must be paid, as specified by you.

currency

The three-letter code of the currency of this invoice, as specified by you.

customer_external_id

The unique identifier for the customer associated with this invoice. Typically an identifier from your internal system.

collection_method

Specifies how the payment for the invoice is collected, with possible values automatic or manual.

status

Specifies the status of the invoice, with possible values open, paid, refunded, voided or written_off.

errors

Specifies if there are any validation errors.

disabled

A boolean stating whether or not the invoice was disabled.

disabled_at

The date and time when the invoice was disabled (null for non-disabled records).

disabled_by

The email address of the user who disabled the invoice (null for non-disabled records).

user_created

A boolean stating whether or not the invoice was created by the user for sources like Stripe, Chargebee, Recurly and Braintree (the latest version of the integration).

edit_history_summary

A summary of edits made to the invoice, available when you set the include_edit_histories query parameter to true. The object is empty if the invoice belongs to a source not supporting data edits.

The summary contains the following properties:

values_changed: The object with the list of edited or added peroperties. Each property that has been edited or added is represented as an object with its original_value and edited_value.
latest_edit_author: The email address of the user who made the most recent edit to the invoice.
latest_edit_performed_at: The timestamp when the most recent edit was made, in ISO 8601 format.

collection_method

Specifies how the payment for the invoice is collected.

automatic — Payments are processed within the billing system without manual intervention (e.g., credit cards, PayPal, direct debits).

manual — Payments are handled outside the billing system and require customer or business action (e.g., checks, manual bank transfers).

line_items

contains an array of line_item objects of this invoice with the following data:

uuid

The UUID of the line_item object generated by ChartMogul.

external_id

The unique external identifier for this line item, as specified by you.

type

The type of line item, either subscription or one_time, as specified by you.

amount_in_cents

The amount in cents charged towards this line item for the specified service period, after discounts and taxes have been applied, as specified by you.

quantity

The quantity of this line item being billed.

discount_code

A reference code for any discount applied to this line item, as specified by you.

discount_amount_in_cents

The discount amount in cents for this line item, as specified by you.

tax_amount_in_cents

The tax amount in cents for this line item, as specified by you.

transaction_fees_in_cents

The transaction fees in cents for this line item, as specified by you.

account_code

The accounting code for the line item, as specified by you.

plan_uuid

The UUID of the plan object associated with the above subscription object, generated by ChartMogul.

plan_external_id

The unique identifier for the plan associated with this invoice. Typically an identifier from your internal system.

transaction_fees_currency

The transaction fees currency for this line item, as specified by you.

discount_description

The discount amount in cents description for this line item, as specified by you.

event_order

A numeric value that determines the sequence in which events are processed when multiple events occur at the same timestamp, as specified by you.

balance_transfer

A boolean stating whether or not this represents a value returned to customer balance.

subscription_uuid

The UUID of the subscription object generated by ChartMogul.

subscription_external_id

The unique external identifier for this subscription, as specified by you.

subscription_set_external_id

An optional unique external identifier for the subscription set to which this subscription belongs, as specified by you.

prorated

A boolean stating whether or not this is a prorated charge for the subscription object, as specified by you.

proration_type

A string defining the type of proration, with possible values differential, full or differential_mrr.

service_period_start

The start of the service period for which the subscription is being charged, as specified by you.

service_period_end

The end of the service period for which the subscription is being charged, as specified by you.

description

A short description of the one_time line item being charged to the customer, as specified by you.

disabled

A boolean stating whether or not the line item was disabled.

disabled_at

The date and time when the line item was disabled (null for non-disabled records).

disabled_by

The email address of the user who disabled the line item (null for non-disabled records).

user_created

A boolean stating whether or not the line item was created by the user for sources like Stripe, Chargebee, Recurly and Braintree (the latest version of the integration).

edit_history_summary

A summary of edits made to the line item, available when you set the include_edit_histories query parameter to true. The object is empty if the invoice and line item belong to a source not supporting data edits.

The summary contains the following properties:

values_changed: The object with the list of edited or added peroperties. Each property that has been edited or added is represented as an object with its original_value and edited_value.
latest_edit_author: The email address of the user who made the most recent edit to the line item.
latest_edit_performed_at: The timestamp when the most recent edit was made, in ISO 8601 format.

transactions

contains an array of transaction objects of this invoice with the following data:

uuid

The UUID of the transaction object generated by ChartMogul.

external_id

The unique external identifier for this transaction, as specified by you.

type

One of payment or refund, as specified by you.

date

The timestamp of when the transaction was attempted, as specified by you.

result

The result of the transaction attempt. One of successful or failed, as specified by you.

amount_in_cents

The amount partially paid/refunded for this transaction.

transaction_fees_in_cents

The final total transaction fees paid to a billing provider and/or payment processor for this line item. Expressed in cents (or pence for GBP, etc.).

transaction_fees_currency

The three-letter currency code for transaction_fees_in_cents. Refer to the full list of supported currencies.

disabled

A boolean stating whether or not the transaction was disabled.

disabled_by

The email address of the user who disabled the transaction (null for non-disabled records).

disabled_at

The date and time when the transaction was disabled (null for non-disabled records).

user_created

A boolean stating whether or not the transaction was created by the user for sources like Stripe, Chargebee, Recurly and Braintree (the latest version of the integration).

edit_history_summary

A summary of edits made to the transaction, available when you set the include_edit_histories query parameter to true. The object is empty if the invoice and transaction belong to a source not supporting data edits.

The summary contains the following properties:

values_changed: The object with the list of edited or added peroperties. Each property that has been edited or added is represented as an object with its original_value and edited_value.
latest_edit_author: The email address of the user who made the most recent edit to the transaction.
latest_edit_performed_at: The timestamp when the most recent edit was made, in ISO 8601 format.

The other keys represent pagination attributes:

cursor: A value that should be used in the next API request to fetch the next page of invoices. Request for next page should be initiated only if has_more is set to true indicating that there are more invoices to list.
has_more: One of true or false depending on whether there are more pages with results for this request.
total_pages deprecated: The total number of pages with results for this request.
current_page deprecated: The page number of this response.