Skip to content

When a catalog plugin is used, some pretty name fields are not returned in an invoice #2017

@reshmabidikar

Description

@reshmabidikar

Steps to reproduce:

  1. Configure a catalog plugin that has the prettyName field set on Plan#finalPhase (similar to the following):
<finalPhase type="EVERGREEN" prettyName="Pistol Monthly Plan Evergreen Phase">
  1. Create a subscription to the above plan
  2. Retrieve the corresponding invoice by id. The invoice item in the invoice data does not include the plan phase pretty name:
{
  "amount": 30,
  "currency": "USD",
  "status": "COMMITTED",
  "creditAdj": 0,
  "refundAdj": 0,
  "invoiceId": "81870a04-477e-473a-b989-0fb0277156ea",
  "invoiceDate": "2024-05-28",
  "targetDate": "2024-05-28",
  "invoiceNumber": "12332",
  "balance": 30,
  "accountId": "5340c612-748c-43cd-810c-7436a8ce738b",
  "bundleKeys": null,
  "credits": null,
  "items": [
    {
      "invoiceItemId": "6b047b37-4fed-4e6d-932c-e7628165df05",
      "invoiceId": "81870a04-477e-473a-b989-0fb0277156ea",
      "linkedInvoiceItemId": null,
      "accountId": "5340c612-748c-43cd-810c-7436a8ce738b",
      "childAccountId": null,
      "bundleId": "0f3fb0b6-074c-453a-8bba-9283f74e9d81",
      "subscriptionId": "5c08fc70-d37c-4b18-ac01-f968b4ee77d5",
      "productName": "Standard",
      "planName": "standard-monthly",
      "phaseName": "standard-monthly-evergreen",
      "usageName": null,
      "prettyProductName": "Standard Product",
      "prettyPlanName": "Standard Monthly Plan",
      "prettyPhaseName": "standard-monthly-evergreen",
      "prettyUsageName": null,
      "itemType": "RECURRING",
      "description": "standard-monthly-evergreen",
      "startDate": "2024-05-28",
      "endDate": "2024-06-28",
      "amount": 30,
      "rate": 30,
      "currency": "USD",
      "quantity": null,
      "itemDetails": null,
      "catalogEffectiveDate": "2020-01-01T00:00:00.000Z",
      "childItems": null,
      "auditLogs": []
    }
  ],
  "trackingIds": [],
  "isParentInvoice": false,
  "parentInvoiceId": null,
  "parentAccountId": null,
  "auditLogs": []
}

The same issue occurs when the catalog plugin has a prettyName configured corresponding to Plan#usages#usage.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions