Invoicing resources now specify how they were generatedBreaking changes

What’s new

We’re introducing a new parent field on invoices, invoice items, and invoice line items. The parent field allows you to view the details of the upstream object that generated the invoice, invoice item, or invoice line item (such as a subscription, a quote, or other). It replaces top level fields that we previously used to reference these objects.

Why is this a breaking change?

• On the Invoice object, we deprecated the quote, subscription, subscription_details, and subscription_proration_date fields.
• On the Invoice Item object, we deprecated the subscription_item and subscription fields.
• On the Invoice Line Item object, we deprecated the type, subscription, subscription_item, invoice_item, proration, and proration_details fields.

Impact

Replace field references on invoicing objects with their new locations in the parent field.

On Invoice objects:

• Use invoice.parent.subscription_details.subscription (verify invoice.parent.type is subscription_details) instead of invoice.subscription.
• This also applies to:
  • quote
  • subscription_details
  • subscription_proration_date

On Invoice Item objects:

• Use invoiceitem.parent.subscription_details.subscription (verify invoiceitem.parent.type is subscription_details) instead of invoice_item.subscription
• This also applies to the subscription_item field

On Invoice Line Item objects:

• Use line_item.parent.subscription_item_details.subscription_item (verify line_item.parent.type is subscription_item_details) instead of line_item.subscription_item.
• This also applies to:
  • subscription
  • invoice_item
  • proration
  • proration_details

Changes

Upgrade