{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Node.js client library 3.10.0 changelog","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"nodejs-client-library-3100-changelog","__idx":0},"children":["Node.js client library 3.10.0 changelog"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"objectqueriesapi","__idx":1},"children":["ObjectQueriesApi"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Renamed methods related to CommitmentCycle to CommitmentPeriod, including queryCommitmentCycleByKeyWithHttpInfo to queryCommitmentPeriodByKeyWithHttpInfo, queryCommitmentCycleByKey to queryCommitmentPeriodByKey, queryCommitmentCyclesWithHttpInfo to queryCommitmentPeriodsWithHttpInfo, and queryCommitmentCycles to queryCommitmentPeriods."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Removed methods related to CommitmentSegment, including queryCommitmentSegmentByKeyWithHttpInfo, queryCommitmentSegmentByKey, queryCommitmentSegmentsWithHttpInfo, and queryCommitmentSegments."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"paymentmethodsapi","__idx":2},"children":["PaymentMethodsApi"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bankAccountType"]}," field to the PAD (Pre-Authorized Debit) payment method request body."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"index","__idx":3},"children":["index"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Replaced CommitmentSegment-related imports and exports with CommitmentPeriod-related ones."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"billingperiod","__idx":4},"children":["BillingPeriod"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added a new billing period type ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Specific_Days"]}," to the BillingPeriod enum."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"commitmentbaseattributes","__idx":5},"children":["CommitmentBaseAttributes"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removed ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["priority"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prorationOption"]}," from the constructor and required properties."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Replaced ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["defaultAssociationRule"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["associationRules"]},", which is now an array."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"commitmentinput","__idx":6},"children":["CommitmentInput"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removed CommitmentCycleAttributes and related properties: cyclePeriodType, specificCyclePeriodLength, and excludeItemBookingFromRevenueAccounting."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Replaced ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["segments"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["periods"]},", changing the constructor and required properties."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removed ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prorationOption"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["defaultAssociationRule"]}," properties."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Changed ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taxCodeName"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taxCode"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["associationRules"]}," as an array of AssociationRule."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new properties: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountReceivableAccountingCode"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["revenueRecognitionTiming"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["revenueAmortizationMethod"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"commitmentoutput","__idx":7},"children":["CommitmentOutput"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Renamed ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["segments"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["periods"]},". This change requires developers to update their code to use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["periods"]}," instead of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["segments"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["startDate"]}," property to represent the start date of the commitment."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["endDate"]}," property to represent the end date of the commitment."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amount"]}," property to represent the total amount of the commitment."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"commonrevenueattributes","__idx":8},"children":["CommonRevenueAttributes"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removed ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["excludeItemBookingFromRevenueAccounting"]}," property, which may require updates to code that relies on this field."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountReceivableAccountingCode"]}," property for specifying the accounting code on the Commitment object."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["revenueRecognitionTiming"]}," property to dictate the type of revenue recognition timing."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["revenueAmortizationMethod"]}," property to dictate the type of revenue amortization method."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"commontaxationattributes","__idx":9},"children":["CommonTaxationAttributes"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Renamed the property ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taxCodeName"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taxCode"]},". This change requires developers to update their code to use the new property name."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"createpadpaymentmethod","__idx":10},"children":["CreatePADPaymentMethod"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added support for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bankAccountType"]}," in CreatePADPaymentMethod, allowing specification of the bank account type using PaymentMethodPADBankAccountType."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"expandedcommitment","__idx":11},"children":["ExpandedCommitment"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removed properties ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["commitmentTemplateId"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["commitmentTemplateNumber"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Renamed property ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taxCodeName"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taxCode"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added new properties: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["revenueRecognitionTiming"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["revenueAmortizationMethod"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountReceivableAccountingCode"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"expandedrateplancharge","__idx":12},"children":["ExpandedRatePlanCharge"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["negotiatedPriceTable"]}," property has been removed and replaced with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isDimensionalPrice"]},". This change requires developers to update their code to use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isDimensionalPrice"]}," as a Boolean instead of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["negotiatedPriceTable"]}," as a String."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"paymentmethodresponse","__idx":13},"children":["PaymentMethodResponse"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added support for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bankAccountType"]}," in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PaymentMethodResponse"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PaymentMethodResponseBankTransfer"]}," models."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"paymentmethodresponsebanktransfer","__idx":14},"children":["PaymentMethodResponseBankTransfer"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added support for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bankAccountType"]}," in PaymentMethodResponseBankTransfer, allowing developers to specify the type of bank account using the PaymentMethodPADBankAccountType model."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"previewoptions","__idx":15},"children":["PreviewOptions"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added a new property ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["skipTax"]}," to the PreviewOptions class, allowing developers to bypass tax calculation during order preview. This can improve performance for customers using external tax engines."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"previewsubscriptionrequest","__idx":16},"children":["PreviewSubscriptionRequest"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Increased the maximum length of the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["notes"]}," field from 500 to 1000 characters."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"upsertcommitmentinput","__idx":17},"children":["UpsertCommitmentInput"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removed ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prorationOption"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["defaultAssociationRule"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cyclePeriodType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["specificCyclePeriodLength"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["excludeItemBookingFromRevenueAccounting"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["segments"]}," properties."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Renamed ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taxCodeName"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taxCode"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["associationRules"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountReceivableAccountingCode"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["revenueRecognitionTiming"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["revenueAmortizationMethod"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["periods"]}," properties."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"upsertcreatecommitmentinput","__idx":18},"children":["UpsertCreateCommitmentInput"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removed parameters ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["priority"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["proration_option"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["segments"]}," from the constructor and replaced ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["segments"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["periods"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removed ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prorationOption"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["defaultAssociationRule"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cyclePeriodType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["specificCyclePeriodLength"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["excludeItemBookingFromRevenueAccounting"]}," properties."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Renamed ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taxCodeName"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taxCode"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["periods"]}," parameter to the constructor."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Introduced ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["associationRules"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountReceivableAccountingCode"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["revenueRecognitionTiming"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["revenueAmortizationMethod"]}," properties."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"upsertupdatecommitmentinput","__idx":19},"children":["UpsertUpdateCommitmentInput"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["segments"]}," property has been replaced with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["periods"]},". Developers need to update their code to use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["periods"]}," instead of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["segments"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["defaultAssociationRule"]}," property has been removed. Any code relying on this property will need to be updated."]}]}]},"headings":[{"value":"Node.js client library 3.10.0 changelog","id":"nodejs-client-library-3100-changelog","depth":1},{"value":"ObjectQueriesApi","id":"objectqueriesapi","depth":2},{"value":"PaymentMethodsApi","id":"paymentmethodsapi","depth":2},{"value":"index","id":"index","depth":2},{"value":"BillingPeriod","id":"billingperiod","depth":2},{"value":"CommitmentBaseAttributes","id":"commitmentbaseattributes","depth":2},{"value":"CommitmentInput","id":"commitmentinput","depth":2},{"value":"CommitmentOutput","id":"commitmentoutput","depth":2},{"value":"CommonRevenueAttributes","id":"commonrevenueattributes","depth":2},{"value":"CommonTaxationAttributes","id":"commontaxationattributes","depth":2},{"value":"CreatePADPaymentMethod","id":"createpadpaymentmethod","depth":2},{"value":"ExpandedCommitment","id":"expandedcommitment","depth":2},{"value":"ExpandedRatePlanCharge","id":"expandedrateplancharge","depth":2},{"value":"PaymentMethodResponse","id":"paymentmethodresponse","depth":2},{"value":"PaymentMethodResponseBankTransfer","id":"paymentmethodresponsebanktransfer","depth":2},{"value":"PreviewOptions","id":"previewoptions","depth":2},{"value":"PreviewSubscriptionRequest","id":"previewsubscriptionrequest","depth":2},{"value":"UpsertCommitmentInput","id":"upsertcommitmentinput","depth":2},{"value":"UpsertCreateCommitmentInput","id":"upsertcreatecommitmentinput","depth":2},{"value":"UpsertUpdateCommitmentInput","id":"upsertupdatecommitmentinput","depth":2}],"frontmatter":{"markdown":{"toc":{"hide":false}},"seo":{"title":"Node.js client library 3.10.0 changelog"}},"lastModified":"2026-01-28T16:35:30.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/sdk-changelogs/nodejs/changelog-3100","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}