These docs are for v1.0. Click to read the latest docs for v2.0.
added

V2 - Customer Invoice Custom Header Fields API

We are happy to announce the introduction of the billing subscriptions management endpoints. This outlines all the available endpoints in the Pennylane V2 API. Refer to the api docs for more details.

New API endpoint for managing custom header fields on customer invoices

A new endpoint GET /api/external/v2/customer_invoices/{customer_invoice_id}/custom_header_fields has been added to retrieve custom header fields associated with a customer invoice.

Enhanced customer invoice responses

All customer invoice API endpoints now include a custom_header_fields URL reference in their response payload, providing easy access to the custom header fields for each invoice. This includes endpoints for creating, updating, listing, and retrieving customer invoices.

 "custom_header_fields": {
   "url": "https://app.pennylane.com/api/external/v2/customer_invoices/42/custom_header_fields"
  },

Custom header fields endpoint

1. List custom header fields

  • RouteGET /api/external/v2/billing_subscriptions
  • Scopescustomer_invoices:all OR `customer_invoices:readonly
{
  "has_more": true,
  "next_cursor": "dXBkYXRlZF9hdDoxNjc0MTIzNDU2",
  "items": [
    {
      "id": 444,
      "title": "customer_reference",
      "value": "REF-12345",
      "rank": 1,
      "created_at": "2025-06-30T10:08:08.146343Z",
      "updated_at": "2025-06-30T10:08:08.146343Z"
    },
    {
      "id": 555,
      "title": "customer_reference",
      "value": "REF-12345",
      "rank": 2,
      "created_at": "2025-06-30T10:08:08.146343Z",
      "updated_at": "2025-06-30T10:08:08.146343Z"
    }
......................................................
  ]
}