> ## Documentation Index
> Fetch the complete documentation index at: https://docs.paygentic.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Changelog

> Product updates and announcements

<Update label="July 6, 2026" tags={["API", "Platform", "Entitlements"]}>
  ## Grants API

  * New optional `priority` field on `POST /v1/entitlements/{entitlementId}/grants` to control the order in which grants are consumed — lower priority burns down first
  * `priority` is now returned on every grant response (create, retrieve, list, and void), so you can confirm the applied value without a follow-up lookup
  * Handy for correction grants: assign a negative priority so an ad-hoc grant is consumed before the recurring allowance

  ## Platform

  * Automatic logout after 5 minutes of inactivity for payments merchants, for added account security
  * Meter event subject IDs now link directly to the matching customer page

  ## Bug Fixes

  * Removed a non-functional logo upload from the merchant onboarding flow
</Update>

<Update label="July 2, 2026" tags={["API", "SDK", "Billing", "Breaking Change"]}>
  ## Plan Creation: `billingVersion: 0` No Longer Accepted

  **Breaking**: `POST /v0/plans` now rejects requests that explicitly pass `billingVersion: 0` with a validation error. New plans can only be created on Standard Billing (`billingVersion: 1`).

  ### What changed

  * Passing `billingVersion: 0` returns a validation error — Legacy Billing plans can no longer be created
  * Omitting `billingVersion` still defaults to `1` (Standard Billing) — no change here
  * Passing `billingVersion: 1` explicitly is unaffected

  ### What's unaffected

  * Existing plans created with `billingVersion: 0` continue to work exactly as before — `billingVersion` cannot be changed after creation, so this is a creation-time restriction only
  * `PATCH` (update plan) never accepted `billingVersion` and is unaffected

  ### If you relied on the old default

  If your integration omitted `billingVersion` expecting Legacy Billing, or explicitly passed `0`, switch to Standard Billing (`billingVersion: 1`, or omit the field). See [Billing Versions](/platform/billing/billing-versions) for a full comparison of capabilities and constraints.
</Update>

<Update label="June 28, 2026" tags={["API", "Platform", "Billing", "Entitlements"]}>
  ## Invoice Refunds

  * Refund invoices via credit notes, with revenue reporting that accounts for refunded amounts

  ## Payments

  * Merchants can now retry an invoice payment directly, with a per-invoice cooldown to prevent duplicate attempts

  ## Payment Methods

  * New Payment Methods section on the customer page to view and manage a customer's saved methods
  * Customers can no longer remove their last payment method while they have an active subscription

  ## Entitlements

  * Filter `GET /v1/entitlements` by external customer ID

  ## Customer Portal

  * Meter usage now appears as clear usage cards on the customer portal and subscription pages, replacing the raw event list
</Update>

<Update label="June 21, 2026" tags={["Platform"]}>
  ## Customer Portal

  * Added a payment-required banner so customers can see at a glance when an invoice needs paying
  * Payment sessions that are completing or still processing no longer show a misleading "Payment Error"
</Update>

<Update label="June 14, 2026" tags={["API", "SDK", "Platform", "Billing"]}>
  ## Metering

  * Meter event ingestion now accepts an `externalId` on each event, so you can tie events back to your own records (API + SDK)

  ## Billing

  * Regenerate the payment link for an invoice at any time
  * Fee prices can now be created with a quantity of 0

  ## Platform

  * Manage customer notification settings directly in the dashboard
</Update>

<Update label="June 7, 2026" tags={["API", "Platform", "Billing"]}>
  ## API

  * `GET /v1/entitlements` (list) and the single-entitlement endpoint now return consistent response shapes

  ## Platform

  * Plan creation no longer shows the legacy billing-version selector — new plans use Standard Billing
  * Invited team members are now activated automatically on first access
  * Invoice PDFs are available from the customer portal even before payment
</Update>

<Update label="May 31, 2026" tags={["API"]}>
  ## Webhooks

  * New `invoice.paid.v0` webhook event fires when an invoice is paid
</Update>

<Update label="May 24, 2026" tags={["API", "SDK", "Billing", "Entitlements"]}>
  ## Entitlements

  * Entitlement template changes now propagate to active subscribers, with broader coverage of template fields

  ## Billing

  * New `defaultQuantity` on Price sets the default quantity for fee invoice lines (API + SDK)
</Update>

<Update label="May 17, 2026" tags={["API", "Platform", "Billing", "Entitlements"]}>
  ## Plans

  * New Advanced Settings and Danger Zone sections on the plan detail page

  ## Entitlements

  * Direct-grant-only entitlements can now be configured with `issueAfterReset` set to 0

  ## Accounting

  * Sync issued invoices to Rillet

  ## Platform

  * Create costs directly in the dashboard
  * Revenue, New Plan, and Cost Explorer now consistently use your primary currency
  * Billable metric creation defaults the aggregation type to SUM
  * Billable metric JSONPath is validated when you save a metric
</Update>

<Update label="May 10, 2026" tags={["API", "SDK", "Platform", "Billing", "Breaking Change"]}>
  ## API Keys

  **Breaking**: Creating an API key (`POST /v0/users/{userId}/apikeys`) now requires a `name` in the request body. Update SDK clients to pass a name before upgrading.

  ## Billing

  * US merchants can opt in to non-sequential invoice numbers
  * Invoice list now paginates for large invoice volumes

  ## Platform

  * Set auto-charge when creating a subscription, directly in the subscription form
  * Capture and store a customer's payment method during subscription setup
</Update>

<Update label="May 3, 2026" tags={["Platform"]}>
  ## Onboarding

  * New quick-start checklist guides you through the initial setup steps
</Update>

<Update label="April 26, 2026" tags={["API", "Platform"]}>
  ## Metering

  * Meter events are now searchable by `externalId`

  ## Performance

  * Reduced the number of API calls the dashboard makes, for faster page loads
</Update>

<Update label="April 17, 2026" tags={["API", "SDK", "Platform", "Billing", "Entitlements"]}>
  ## Cost Explorer

  * New Cost Explorer page for analyzing revenue and costs across your customer base
  * Break down costs by type, customer, or custom dimension
  * Chart and table views with sorting, pagination, and drill-down navigation
  * Filter by date range and subject — searchable by customer name

  ## Raw Meter Events

  * New raw events view inside each billable metric — inspect the individual events feeding your usage aggregations
  * Filter by subject to focus on a specific customer's event stream
  * Idempotency keys visible directly in the event list

  ## Entitlements: Query at a Point in Time

  * New optional `at` parameter on `GET /v1/entitlements` and `GET /v1/entitlements/{id}`
  * Pass an ISO 8601 timestamp to check balance, access, and period bounds at any point in time
  * TypeScript and Python SDKs updated

  ## Entitlements: Automatic Grant Reinitialization

  * When a plan's entitlement template is updated (rollover policy, expiry, reset behaviour), active subscribers' grants are automatically reinitialized at the next billing period boundary
  * Rolled-over balance is preserved — a one-time seed grant carries existing balance forward

  ## Grant Discounts on Invoices

  * When `grantDiscountEnabled` is set on a price, unused grant balance now appears as a dedicated discount line item on the invoice
  * Previously, grant discounts were applied implicitly; they are now visible and auditable

  ## Platform

  * Invoice review step added when creating in-advance subscriptions — see line items and totals before confirming
  * Revamped onboarding wizard with improved layout, radio card selection, and clearer step flow
  * Filter customers directly from the customers list by name or email
  * Improved metered entitlements table in the customer portal — clearer layout and consistent styling
  * Customer portal hides legacy usage history for v1 subscriptions (line-item billing shows invoice data instead)
</Update>

<Update label="April 2026" tags={["API", "SDK", "Billing", "Migration"]}>
  ## Migration: `billingInterval` → `billingCadence`

  Plans now use `billingCadence` (ISO 8601 duration) as the primary billing period field. `billingInterval` is deprecated in responses and will be removed in a future version.

  ### Mapping

  | Old `billingInterval` | New `billingCadence` |
  | --------------------- | -------------------- |
  | `"monthly"`           | `"P1M"`              |
  | `"quarterly"`         | `"P3M"`              |
  | `"yearly"`            | `"P1Y"`              |

  ### Input (create/update plan)

  * New: send `billingCadence: "P3M"` for quarterly billing
  * The old `billingInterval` field is still accepted for backwards compatibility
  * When both are provided, `billingCadence` takes precedence

  ### Output (plan response)

  * Both fields are present in responses during the deprecation window
  * `billingCadence` is the source of truth (ISO 8601 duration)
  * `billingInterval` is derived from `billingCadence` and marked **deprecated**

  ### SDK update

  Update any code that reads or writes `billingInterval` to use `billingCadence` instead. The SDK will emit deprecation warnings on the old field.
</Update>

<Update label="March 18, 2026" tags={["API", "Platform", "SDK", "Billing"]}>
  ## Revenue Analytics

  * New revenue dashboard for billing v1 — visualize revenue by hour, day, or as a cumulative total
  * Drill into revenue by customer or subscription, and track financials from a single consolidated view

  ## Payment Links

  * Payment links can now be created and managed directly from the dashboard
  * Supports line items, customer assignment, and status tracking

  ## Payments API

  * New Payments API to process payments programmatically
  * Subscribe to payment lifecycle events via webhooks

  ## Grants API

  * Manage grants mid-cycle: create, list, retrieve, and void grants on any entitlement via REST
    * `POST /v1/entitlements/{entitlementId}/grants`
    * `GET /v1/entitlements/{entitlementId}/grants`
    * `DELETE /v1/entitlements/{entitlementId}/grants/{grantId}`
  * Grant purchase and direct creation are now available in the public API and SDK

  ## Webhooks

  * New `invoice.issued.v0` webhook event fires when an invoice is issued

  ## API

  * New endpoint to manually create line items on an invoice
  * `listCustomers` now supports filtering by name and email

  ## Platform

  * Duplicate any plan (including all its prices) from the plan actions menu
  * New usage onboarding flow with a metric wizard for usage-based plan setup
  * Customers list now paginates for large customer counts
</Update>

<Update label="March 1, 2026" tags={["API", "Platform", "SDK", "Billing"]}>
  ## Python SDK

  * Official [Paygentic Python SDK](https://pypi.org/project/paygentic/) now available, powered by Speakeasy
  * Full parity with the TypeScript SDK for all API interactions

  ## Metered Entitlements

  * Metered entitlements now supported — charge customers based on actual usage of features
  * Metered line items automatically collected and synced to invoices on your billing schedule
  * New `GET /v2/invoices/lineItems` endpoint to retrieve detailed line item breakdowns per invoice
  * SDK updated to support metered entitlements and subscription-scoped entitlement listing

  ## API Enhancements

  ### Currencies

  * Added support for **GBP** and **AUD** as merchant billing currencies

  ### Customers

  * New endpoint to delete customers — historical data is preserved

  ### Billing Metrics

  * Billable metric meter endpoint now available in the public API and SDK — query real-time usage data for a given customer and metric

  ### Entitlements

  * Filter entitlement checks by subscription when a customer has multiple active subscriptions

  ### Email Notifications

  * Custom email routing: configure a custom "from" address for billing notification emails sent to your customers
  * Invoice and portal links in emails now expire after 7 days for security

  ### Plans

  * Plans now include a `billingVersion` field distinguishing legacy and line-item-based billing

  ## Customer Portal

  * Customers can now add and remove their own payment methods directly in the portal
  * New entitlements view showing customers their active features and usage entitlements
  * Address fields on the customer creation form now support autocompletion

  ## Platform Updates

  * "Show exact balance" toggle replaces nano-unit labels for clearer wallet balance display
  * Streamlined merchant onboarding — the consumer/merchant type selection step has been removed for a simpler signup flow

  ## Bug Fixes

  * Fixed metered line items to correctly apply payment term `in_arrears`
  * Fixed sandbox invite links to preserve the return URL after login
  * Standardized required field indicators across all platform forms
</Update>

<Update label="February 13, 2026" tags={["API", "Platform", "SDK"]}>
  ## Multi-Currency Support

  * Notifications for invoices, payments, and subscriptions now display amounts in the merchant's configured currency
  * Payment sessions updated with multi-currency support
  * Tax provider contact details now kept automatically in sync

  ## Platform Updates

  ### Customer Portal

  * Refreshed customer portal UI
  * Enhanced wallet balance display with a new balance header

  ### Bug Fixes

  * Fixed inconsistent address autocomplete behavior

  ## SDK

  * Official [Paygentic TypeScript SDK](https://www.npmjs.com/package/@paygentic/sdk) now available (beta) with automated publishing
</Update>

<Update label="January 5-27, 2026" tags={["API", "Platform", "Entitlements"]}>
  ## Major Release: Features & Entitlements

  ### Feature Management

  * Define features that can be gated for your customers (e.g., "SSO Access", "Premium Support")
  * New Feature Management UI to create and manage features directly in the dashboard
  * Link features to prices when creating or editing pricing plans
  * Automatic entitlement provisioning when customers subscribe to plans with linked features

  ### Entitlement Access API

  * New public API endpoint (`/v1/entitlements`) to check if a customer has access to a specific feature
  * Support for static (config-based) and boolean (on/off) feature types

  ## API Enhancements

  ### Webhooks

  * New `subscription.renewed.v0` webhook event when subscriptions enter a new billing period

  ### Customer Management

  * Customer name and email now editable directly from the customer detail page
  * Fee management endpoints added to public API documentation

  ### Payments

  * Expired payment session links now automatically regenerate with a new email sent to customers
  * Added Australia to merchant eligible countries

  ## Email Notifications

  * Email notification when invoice is **issued** (for manual payment invoices)
  * Email notification when invoice is **paid** with links to invoice and receipt
  * Email reminder before subscription renewal

  ## Bug Fixes

  * Fixed micro-pricing truncation in percentage-based prices
  * Fixed payment retry flow when initial payment attempt fails
  * Fixed fee dropdown showing fees from other products
</Update>

<Update label="October 21-27, 2025" tags={["API", "Platform", "Docs"]}>
  ## API Improvements

  ### Enhanced Invoice Management

  * Added `merchantId` field to all invoice V2 endpoint responses for better multi-merchant support
  * Improved manual Event Source sync capabilities with rate limiting for better integration control

  ### Security & Environment Management

  * API keys now include environment prefixes for clearer identification across different environments
  * Enhanced security for API key management

  ## Platform Updates

  ### User Experience Improvements

  * Added pagination to subscriptions table for better performance with large datasets
  * Fixed return URL configuration for payment topups
  * Minor bug fixes

  ### Environment Awareness

  * New banner displays current environment (sandbox, staging, production) for clearer context
  * Added quick navigation links to sandbox environment
</Update>

<Update label="October 14-20, 2025" tags={["API", "Platform", "Billing"]}>
  ## Major Release: Tax Integration

  ### Paygentic Tax

  * Complete tax automation with Paygentic Tax integration
  * Automatic tax calculation and reporting
  * Support for international tax compliance

  ## API Enhancements

  ### Customer Management

  * Enabled tax ID and tax rate updates for merchant-managed customers
  * Added address modification capabilities for merchant-managed consumers
  * Enhanced subscription and customer ID tracking in source event responses

  ### Data Integrity

  * Prevented duplicate prices per billable metric in plans
  * Improved conflict detection for existing subscriptions

  ## Platform Features

  ### Payment Methods Portal

  * New self-service payment methods management in customer portal
  * Improved payment method handling and invoice card filtering
  * Enhanced off-session payment flow for automatic billing

  ## Documentation Updates

  * Comprehensive documentation for payment terms
  * Detailed metric modes explanation
  * Updated billing guides
</Update>
