feat(payments): document list filters on findAllPayments - #579
Draft
sarkissianraffi wants to merge 2 commits into
Draft
sarkissianraffi wants to merge 2 commits into
sarkissianraffi wants to merge 2 commits into
Conversation
Document shared list filters for payments and customer payments, including array serialization, exact number matches, inclusive date and int64 amount bounds, validation errors and pagination semantics. Regenerate the public bundle without changing response schemas.
This was referenced Sep 7, 2026
Removed with the API filter for performance reasons. SDK clients and the CLI are generated from this bundle and must be regenerated before release.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Document every payment list filter on findAllPayments and findAllCustomerPayments, including currency and search that REST previously omitted. Split parameter sources and the regenerated root openapi.yaml are committed; payment response schemas and all other operations are unchanged.
payment_status/payment_statusespaymentStatusamount_from,amount_toamountFrom,amountToreceipt_numberreceiptNumbercreated_at_from,created_at_tocreatedAtFrom,createdAtTopayment_provider_typepaymentProviderTypecurrencycurrencyinvoice_numberinvoiceNumberexternal_customer_idexternalCustomerIdpayment_typepaymentTypepayable_typepayableTypesearch_termsearchTermAll filters AND together; array entries OR together. Existing page, per_page, invoice_id and GraphQL pagination/search arguments remain supported.
Arrays use repeated bracketed keys (
payment_status[]=succeeded&payment_status[]=failed) with form/explode serialization; descriptions also document accepted scalar forms and the plural status alias. Includes enum values, inclusive int64 amount bounds, exact case-insensitive text limits, organization-timezone dates, 422 validation and pagination semantics.Verification
npm run buildandnpm testpass with zero errors.API and client QA, 79 HTTP assertions, cross-client IDs, UI QA and recording
Scope notes
The requested
feat/payments-list-filtersbranch overrides the older template's feature/ prefix. The template's Ruby test command does not apply to this repository; both OpenAPI lint suites pass. One implementation commit. Invoice amount parameters remain unchanged because their existing input contract differs from nonnegative int64 payment bounds. Reuses the existing shared currency parameter without broadening unrelated currency schemas. No serializer changes or export.Related PRs
Merge order: API, then front; OpenAPI before client/CLI releases. JavaScript CI uses the pinned feature spec during that rollout.
Performance follow-up (2026-09-09)
payment_method_type[]removed fromGET /paymentsandGET /customers/{external_customer_id}/payments: the API dropped the filter for performance reasons (feat(payments): add list filters to payments (REST + GraphQL) lago-api#6325, "Not shipped for performance reasons"). Parameter file, registry entry and both resource references removed; bundle rebuilt;npm testgreen (0 errors, pre-existing warnings only).