### v2.46.0 (2025-03-06) * * * ### New Input Params: * created_at has been added to Invoice#LineItemsImportInputParams. * PaymentIntent has been added to Purchase#CreateInputParams. ### New Enums: * SUBSCRIPTION_ENTITLEMENTS_UPDATED has been added to EventType#Enum. ### v2.45.0 (2025-02-10) * * * #### New Resources: * Rule has been added. * UsageEvent has been added. #### New Attribute: * deleted has been added to AttachedItem. * deleted has been added to Coupon. * deleted has been added to DifferentialPrice. * deleted has been added to ItemFamily. * deleted has been added to ItemPrice. * deleted has been added to Item. * deleted has been added to PriceVariant. * tax_application has abeend added to CreditNote#Allocation. * tax_application has been added to Invoice#AppliedCredit. * line_item_credit has been added to Invoice. #### New Input Params: * exhausted_coupon_ids has been added to Subscription#ImportForItems. #### New Enums * STORE has been added in CreditNote#TypeEnum. * STORE has been added in CreditNoteEstimate#TypeEnum. * STORE has been added in Order#TypeEnum. * TaxApplicationEnum has been added in CreditNote#Application. * TaxApplicationEnum has been added in Invoice#AppliedCredit. * RECORDED_PURCHASE has been added in EntityTypeEnum. * RECORD_PURCHASE_FAILED, has been added in EventTypeEnum. #### Deleted Input Params * tax_providers_fields has been removed from Customer#MoveParams. * tax_providers_fields has been removed from Customer#MergeParams #### Deprecated input params. * deprecated label in discount_quantity has been removed from Coupon#CreateParams. * deprecated label in discount_quantity has been removed from Coupon#UpdateParams. * deprecated label in discount_quantity has been removed from Coupon#CreateForItemsParams. * deprecated label in discount_quantity has been removed from Coupon#UpdateForItemsParams. ### v2.44.0 (2024-12-19) * * * #### New Resource: * Configuration has been added. #### New Attribute: * discount_type has been added to CreditNote#Discount. * discount_type has been added to CreditNoteEstimate#Discount. * discount_type has been added to Invoice#Discount. * discount_type has been added to InvoiceEstimate#Discount. * discount_type has been added to QuoteLineGroup#Discount. * initial_purchase_transaction has been added to OmnichannelSubscription. * error_cause_id has been added to GatewayErrorDetail. * error_cause_id has been added to Transaction#GatewayErrorDetail. * error_cause_id has been added to APIError. * deleted has been added to Quote. * current_term_start has been added to QuotedSubscripiton#SubscriptionItem. * current_term_end has been added to QuotedSubscripiton#SubscriptionItem. * next_billing_at has been added to QuotedSubscripiton#SubscriptionItem. * current_term_start has been added to Subscription#SubscriptionItem. * current_term_end has been added to Subscription#SubscriptionItem. * next_billing_at has been added to Subscription#SubscriptionItem. * billing_override has been added to Subscription. * grace_period_expires_at has been added to OmnichannelSubscriptionItem. #### New Input Params: * billing_override has been added to Subscription#UpdateForItemsInputParam. * billing_override has been added to Subscription#CreateWithItemsInputParam. #### New Enum Values: * OMNICHANNEL_SUBSCRIPTION_IMPORTED has been added to EventTypeEnum. * DISABLED has been added to Event#WebhookStatus. * OMNICHANNEL_SUBSCRIPTION_ITEM_GRACE_PERIOD_STARTED has been added to EventTypeEnum. * OMNICHANNEL_SUBSCRIPTION_ITEM_GRACE_PERIOD_EXPIRED has been added to EventTypeEnum. * OMNICHANNEL_SUBSCRIPTION_ITEM_DUNNING_STARTED has been added to EventTypeEnum. * OMNICHANNEL_SUBSCRIPTION_ITEM_DUNNING_EXPIRED has been added to EventTypeEnum. * IGNORED has been added to RecordedPurchase#StatusEnum. * IN_DUNNING & IN_GRACE_PERIOD have been added to OmnichannelSubscriptionItem#StatusEnum. ### v2.43.0 (2024-11-27) #### New Resource: * OmnichannelSubscriptionItem has been added. #### New Attribute: * resource_version has been added to OmnichannelSubscription. * resource_version has been added to OmnichannelTransaction. * resource_version has been added to RecordedPurchase. #### New Input Parameters: * limit has been added to OmnichannelSubscription#ListRequest. * offset has been added to OmnichannelSubscription#ListRequest. * customer_id has been added to OmnichannelSubscription#ListRequest. * replace_coupon_list has been added to HostedPage#CheckoutExistingRequest. * replace_coupon_list has been added to HostedPage#CheckoutExistingForItemsRequest. * subscription[po_number] has been added to HostedPage#CheckoutNewForItemsRequest. #### Removed Subresource: * OmnichannelSubscriptionItem subresource has been removed from OmnichannelSubscription and is now a standalone resource. #### Deprecated Attribute: * metadata has been deprecated from subscription. ### v2.42.0 (2024-11-14) * * * #### New Resource: * OmnichannelTransaction has been added. * OmnichannelSubscription has been added. * RecordedPurchase has been added. #### New Attributes: * business_entity_id has been added to AttachedItem. * business_entity_id has been added to DifferentialPrice. * business_entity_id has been added to Items. * business_entity_id has been added to ItemFamily. * business_entity_id has been added to ItemPrice. * business_entity_id has been added to PriceVariant. * valid_from has been added to coupon. #### New Input Parameters: * business_entity_id has been added to AttachedItem#CreateRequest. * preferred_scheme has been added to Card#UpdateCardForCustomerRequest. * valid_from has been added to Coupon#CreateForItem & Coupon#UpdateForItemsRequest. * preferred_scheme has been added to Customer#CreateRequest & Customer#CollectPaymentRequest. * business_entity_id has been added to DifferentialPrice#CreateRequest. * preferred_scheme has been added to Invoice#CreateRequest & Invoice#CreateForChargeItemsAndChargesRequest. * business_entity_id has been added to Items#CreateRequest. * business_entity_id & include_site_level_resources have been added to Items#ListItemParams. * business_entity_id has been added to ItemFamily#CreateRequest. * business_entity_id & include_site_level_resources have been added to ItemFamily#ListItemFamilyParams. * business_entity_id has been added to ItemPrice#CreateRequest. * business_entity_id & include_site_level_resources have been added to ItemPrice#ListItemPriceParams. * business_entity_id & include_site_level_resources have been added to PriceVariant#ListItemFamilyParams. * business_entity_id has been added to PriceVariant#CreateRequest. * business_entity_id & include_site_level_resources have been added to PriceVariant#ListPriceVariantParams. * preferred_scheme has been added to Subscription#CreateRequest, Subscription#UpdateRequest. * preferred_scheme Subscription#UpdateForItemsRequest, & Subscription#ImportSubscriptionRequest. * business_entity_id & include_site_level_resources have been added to Export#ItemFamiliesRequest & Export#ItemsRequest. * business_entity_id & include_site_level_resources have been added to Export#ItemPricesRequest Export#PriceVariantsRequest * name & flexible_schedules[period] have been added to PaymentScheduleScheme#CreateRequest. #### New Enum Values: * FUTURE has been added to Coupon#StatusEnum. * EXISTING_CUSTOMER & NEW_CUSTOMER have been added to Coupon#TypeEnum. * LATE_FAILURE has added to Transation#LinkedPaymentEnum & Transation#StatusEnum. * OMNICHANNEL_SUBSCRIPTION, has been added to EntityTypeEnum. * OMNICHANNEL_SUBSCRIPTION_ITEM, has been added to EntityTypeEnum. * OMNICHANNEL_TRANSACTION, has been added to EntityTypeEnum. * OMNICHANNEL_SUBSCRIPTION_ITEM_RENEWED, has been added to EventTypeEnum. * OMNICHANNEL_SUBSCRIPTION_CREATED, has been added to EventTypeEnum. * OMNICHANNEL_SUBSCRIPTION_ITEM_DOWNGRADE_SCHEDULED, has been added to EventTypeEnum. * OMNICHANNEL_SUBSCRIPTION_ITEM_SCHEDULED_DOWNGRADE_REMOVED, has been added to EventTypeEnum. * OMNICHANNEL_SUBSCRIPTION_ITEM_DOWNGRADED, has been added to EventTypeEnum. * OMNICHANNEL_SUBSCRIPTION_ITEM_EXPIRED, has been added to EventTypeEnum. * OMNICHANNEL_SUBSCRIPTION_ITEM_CANCELLATION_SCHEDULED, has been added to EventTypeEnum. * OMNICHANNEL_SUBSCRIPTION_ITEM_SCHEDULED_CANCELLATION_REMOVED, has been added to EventTypeEnum. * OMNICHANNEL_SUBSCRIPTION_ITEM_RESUBSCRIBED, has been added to EventTypeEnum. * OMNICHANNEL_SUBSCRIPTION_ITEM_UPGRADED, has been added to EventTypeEnum. * OMNICHANNEL_SUBSCRIPTION_ITEM_CANCELLED, has been added to EventTypeEnum. ### v2.41.0 (2024-10-17) * * * #### New Resource: * PaymentScheduleEstimate has been added. ### New Attributes: * payment_schedule_estimates has been added to Estimate. * usage_accumulation_reset_frequency has been added to ItemPrice. * name has been added to PaymentScheduleScheme. * usage_accumulation_reset_frequency has been added to QuotedSubscription#SubscriptionItem. * usage_accumulation_reset_frequency has been added to Subscription#SubscriptionItem. ### New Endpoints: * Estimate#PaymentSchedule has been added. ### New Input Params: * usage_accumulation_reset_frequency has been added to ItemPrice#CreateParams. * usage_accumulation_reset_frequency has been added to ItemPrice#UpdateParams. * discounts has been added to PricingPageSession#CreateForNewSubscriptionParams. * discounts has been added to PricingPageSession#CreateForExistingSubscriptionParams. * invoice_immediately has been added to Quote#ConvertParams. ### v2.40.1 (2024-10-03) * * * #### Bug Fixes: * metadata field not working bug fixed. * meta_data field not working bug fixed. ### v2.40.0 (2024-09-19) * * * #### New Resource: * PaymentScheduleScheme has been added. * PaymentSchedule has been added. ### New Endpoints: * Invoice#ApplyPaymentScheduleScheme has been added. * Invoice#PaymentSchedules has been added. ### New Attributes * bundle_items[] has been added to Items. * bundle_configuration has been added to Items. #### New Input parameters: * bundle_configuration has been added to Items#CreateParams, Items#UpdateParams & Items#ListParams. * bundle_items_to_add[] has been added to Items#CreateParams & Items#UpdateParams. * bundle_items_to_update[] has been added to Items#UpdateParams. * bundle_items_to_remove[] has been added to Items#UpdateParams. * payment_schedule has been added to Purchase#CreateParams. ### New Enum Values: * payment_schedules_created has been added to EventTypeEnum. * payment_schedules_updated has been added to EventTypeEnum. * payment_schedule_scheme_created has been added to EventTypeEnum. * payment_schedule_scheme_deleted has been added to EventTypeEnum. ### Removed Resource: * Installment has been removed. * InstallmentConfig has been removed. * InstallmentDetail has been removed. ### Removed Endpoints: * Invoice#Installments has been removed. ### Removed Input parameters: * installment_info has been removed from Purchase#CreateParams. ### Removed Enum Values: * invoice_installments_created has been removed from EventTypeEnum. * invoice_installment_updated has been removed from EventTypeEnum. * installment_config_created has been removed from EventTypeEnum. * installment_config_deleted has been removed from EventTypeEnum. ### v2.39.0 (2024-08-29) * * * #### New Resource: * CustomerEntitlement has been added. #### New Endpoints: * Ramp#UpdateRequest has been added to Ramp resource. * Transaction#ReconcileRequest has been added to Transaction resource. ### New Attributes: * arr has been added to Subscription. ### New Enum Values: * customer_entitlements_updated has been added to EntityTypeEnum. * subscription_moved_in has been added in EventType enum. * subscription_moved_out has been added in EventType enum. * subscription_movement_failed has been added in EventType enum. ### v2.38.0 (2024-08-14) * * * #### New Attributes: * feature_type has been added in SubscriptionEntitlement. * business_entity_id has been made optional in Quote. * business_entity_id has been made optional in CreditNote. #### New Input parameters: * invoice_usages has been added in Subscription#UpdateForItemsRequest. * invoice_usages has been added in Estimate#UpdateSubscriptionForItemsRequest. ### v2.37.0 (2024-07-31) * * * #### New Resource: * Metadata has been added. #### New Attributes: * variant_group has been added in PriceVariant resource. * effective_from & schedule_status have been added in EntitlementOverride resource. * effective_from & schedule_status have been added in SubscriptionEntitlement resource. * status_transition_reason has been added in Ramp subresource. * billing_period & billing_period_unit have been added in SubscriptionItem subresource. #### New Input parameters: * variant_group has been added to PriceVariant#CreateRequest, PriceVariant#UpdateRequest. * include_scheduled_overrides has been added to SubscriptionEntitlement#SubscriptionEntitlementsForSubscriptionRequest. * entitlement_overrides[effective_from] has been added to SubscriptionEntitlement#SubscriptionEntitlementsForSubscriptionRequest. * entitlement_overrides[effective_from] has been added to EntitlementOverride#AddEntitlementOverrideForSubscriptionRequest. * include_scheduled_overrides has been added to EntitlementOverride#ListEntitlementOverrideForSubscriptionRequest. * updated_at has been added to Usage#ListRequest. #### New Enum values: * SUBSCRIPTION_ITEMS_RENEWED has been added in EventType enum. * SUBSCRIPTION_RAMP_DRAFTED has been added in EventType enum. * SUBSCRIPTION_RAMP_UPDATED has been added in EventType enum. ### Bug Fixes: * estimate.invoiceEstimate should return undefined instead of empty object. ### v2.36.0 (2024-07-19) * * * #### New Input parameters: * change_option has been added to HostedPage#CheckoutExistingForItemsRequest. * changes_scheduled_at has been added to HostedPage#CheckoutExistingForItemsRequest. ### v2.35.0 (2024-07-04) * * * * Moved @types/q from dependencies to devDependencies to fix https://github.com/chargebee/chargebee-typescript/issues/55. ### v2.34.0 (2024-07-03) * * * #### New resources: * Currency has been added. * PricingPageSession Transfer has been added. #### New Enum * cancel_option Enum has been added. #### New Enum values: * ONLINE_BANKING_POLAND has been added in PaymentMethod enum. * ONLINE_BANKING_POLAND has been added in PaymentMethodType enum. * ONLINE_BANKING_POLAND has been added in Type enum. * DRAFT has been added in Ramp enum. #### New Input parameters: * cancel_option has been added to Estimate#CancelSubscriptionRequest, Estimate#CancelSubscriptionForItemsRequest. * cancel_option has been added to Subscription#CancelForItemsRequest, Subscription#CancelRequest. * statement_descriptor[descriptor] has been added to Purchase#ChargeRequest. #### New Attributes: * tax_origin has been added to Invoice. * tax_origin has been added to CreditNote. ### v2.33.0 (2024-05-28) * * * #### New resources: * BusinessEntity has been added. * BusinessEntity Transfer has been added. #### New Enum values: * NUVEI has been added in Gateway enum. #### New Attributes: * site_details_at_creation has been added to CreditNote. * site_details_at_creation has been added to Invoice. #### New Input parameters: * tax_providers_fields[provider_name] has been added to Addon#CreateRequest, Addon#UpdateRequest. * tax_providers_fields[field_id] has been added to Addon#CreateRequest, Addon#UpdateRequest. * tax_providers_fields[field_value] has been added to Addon#CreateRequest, #UpdateRequest. * tax_providers_fields[provider_name] has been added to Customer#CreateRequest, Customer#UpdateRequest, Customer#MoveRequest. * tax_providers_fields[field_id] has been added to Customer#CreateRequest, Customer#UpdateRequest, Customer#MoveRequest. * tax_providers_fields[field_value] has been added to Customer#CreateRequest, Customer#UpdateRequest, Customer#MoveRequest.. * tax_providers_fields[provider_name] has been added to Estimate#CreateSubscriptionRequest, Estimate#CreateSubItemEstimateRequest, Estimate#CreateInvoiceRequest, CreateInvoiceForItemsRequest. * tax_providers_fields[field_id] has been added to Estimate#CreateSubscriptionRequest, Estimate#CreateSubItemEstimateRequest, Estimate#CreateInvoiceRequest, CreateInvoiceForItemsRequest. * tax_providers_fields[field_value] has been added to Estimate#CreateSubscriptionRequest, Estimate#CreateSubItemEstimateRequest, Estimate#CreateInvoiceRequest, CreateInvoiceForItemsRequest. * tax_providers_fields[provider_name] has been added to Invoice#CreateRequest, Invoice#CreateForChargeItemsAndChargesRequest, Invoice#ChargeRequest. * tax_providers_fields[field_id] has been added to Invoice#CreateRequest, Invoice#CreateForChargeItemsAndChargesRequest, Invoice#ChargeRequest. * tax_providers_fields[field_value] has been added to Invoice#CreateRequest, Invoice#CreateForChargeItemsAndChargesRequest, Invoice#ChargeRequest. * tax_providers_fields[provider_name] has been added to ItemPrice#CreateRequest, ItemPrice#UpdateRequest. * tax_providers_fields[field_id] has been added to ItemPrice#CreateRequest, ItemPrice#UpdateRequest. * tax_providers_fields[field_value] has been added to ItemPrice#CreateRequest, ItemPrice#UpdateRequest. * tax_providers_fields[provider_name] has been added to Plan#CreateRequest, Plan#UpdateRequest. * tax_providers_fields[field_id] has been added to Plan#CreateRequest, Plan#UpdateRequest. * tax_providers_fields[field_value] has been added to Plan#CreateRequest, Plan#UpdateRequest. * tax_providers_fields[provider_name] has been added to Quote#EditOneTimeQuoteRequest, Quote#CreateForOnetimeChargesRequest, Quote#CreateForChargeItemsAndChargesRequest, Quote#EditForChargeItemsAndChargesRequest. * tax_providers_fields[field_id] has been added to Quote#EditOneTimeQuoteRequest, Quote#CreateForOnetimeChargesRequest, Quote#CreateForChargeItemsAndChargesRequest, Quote#EditForChargeItemsAndChargesRequest. * tax_providers_fields[field_value] has been added to Quote#EditOneTimeQuoteRequest, Quote#CreateForOnetimeChargesRequest, Quote#CreateForChargeItemsAndChargesRequest, Quote#EditForChargeItemsAndChargesRequest. * tax_providers_fields[provider_name] has been added to UnbilledCharge#CreateUnbilledChargeRequest, UnbilledCharge#CreateRequest. * tax_providers_fields[field_id] has been added to UnbilledCharge#CreateUnbilledChargeRequest, UnbilledCharge#CreateRequest. * tax_providers_fields[field_value] has been added to UnbilledCharge#CreateUnbilledChargeRequest, UnbilledCharge#CreateRequest. * line_items[entity_type] has been added to CreditNote#CreateRequest. * line_items[entity_id] has been added to CreditNote#CreateRequest. ### v2.32.1 (2024-05-02) * * * #### Removed resources: * Session has been removed. ### v2.32.0 (2024-04-30) * * * #### New resources: * PriceVariant has been added. * Ramp has been added. * InstallmentDetail has been added. * Session has been added. * Ramp has been added. #### New Enum values: * INVOICE_INSTALLMENTS_CREATED has been added in EventType enum. * INVOICE_INSTALLMENT_UPDATED has been added in EventType enum. * INSTALLMENT_CONFIG_CREATED has been added in EventType enum. * INSTALLMENT_CONFIG_DELETED has been added in EventType enum. * RAMP_CREATED has been added in EventType enum. * RAMP_DELETED has been added in EventType enum. * RAMP_APPLIED has been added in EventType enum. #### New Attributes: * tax_providers_fields has been added to Addon resource. * tax_providers_fields has been added to Customer resource. * tax_providers_fields has been added to ItemPrice resource. * tax_providers_fields has been added to Plan resource. * resource_version has been added to Installment resource. * resource_version has been added to InstallmentConfig resource. * KlarnaPayNow has been added to PaymentSource resource. * business_entity_id has been added to UnbilledCharge resource. #### New Endpoints: * Exports#PriceVariantsRequest has been added to Exports resource. #### New Input parameters: * changes_scheduled_at, change_option has been added to Estimate#UpdateSubscriptionRequest. * changes_scheduled_at, change_option has been added to Estimate#UpdateSubscriptionForItemsRequest. * contract_term[contract_start] has been added to Estimate#CreateSubItemEstimateRequest. * contract_term[contract_start] has been added to Estimate#CreateSubItemForCustomerEstimateRequest. * contract_term[contract_start] has been added to Subscription#CreateWithItemsRequest. * contract_term[contract_start] has been added to Subscription#UpdateForItemsRequest. * price_variant_id has been added to ItemPrice#CreateRequest. * price_variant_id has been added to ItemPrice#UpdateRequest. * price_variant_id has been added to ItemPrice#ListRequest. #### Removed attributes: * additional_info has been removed from Invoice#StatmentDescriptor resource. #### Removed Input parameters: * additional_info has been removed from Subscription#CreateRequest. * additional_info has been removed from Subscription#CreateForCustomerRequest. * additional_info has been removed from Subscription#CreateWithItemsRequest. * additional_info has been removed from Subscription#UpdateRequest. * additional_info has been removed from Subscription#UpdateForItemsRequest. * additional_info has been removed from Subscription#ReactivateRequest. ### v2.31.1 (2024-04-03) * * * #### New Input parameters: * to_customer_id has been added to subscription#MoveRequest. * copy_payment_source has been added to subscription#MoveRequest. #### New endpoints: * Subscription#MoveRequest has been added to the Subscription resource. ### v2.31.0 (2024-03-20) * * * #### New resources: * Attribute has been added. * ImpactedItemPrice has been added. * InstallmentConfig has been added. * Installment has been added. #### Removed attributes: * product_id has been removed from ItemPrice resource. #### New Enum values: * klarna_pay_now has been added to TypeEnum in Customer resource. * klarna_pay_now has been added to PaymentMethodEnum. * klarna_pay_now has been added to PaymentMethodTypeEnum enum. * klarna_pay_now has been added to TypeEnum. * price_variant has been added to EntityTypeEnum. * price_variant_created has been added in EventType enum. * price_variant_updated has been added in EventType enum. * price_variant_deleted has been added in EventType enum. #### Removed Enum values: * product and variant have been removed from EntityTypeEnum. #### New Input parameters: * config_id has been added to Invoice#InstallmentsRequest. * amount has been added to Invoice#InstallmentsRequest. * payment_source_id has been added to Purchase#CreateRequest. * installment_info[config_id] has been added to Purchase#CreateRequest. * installment_info[amount] has been added to Purchase#CreateRequest. * subscription_info[contract_term_billing_cycle_on_renewal] has been added to Purchase#CreateRequest. * contract_terms[index] has been added to Purchase#CreateRequest. * contract_terms[action_at_term_end] has been added to Purchase#CreateRequest. * contract_terms[cancellation_cutoff_period] has been added to Purchase#CreateRequest. * subscription_info[contract_term_billing_cycle_on_renewal] has been added to Purchase#EstimateRequest. * contract_terms[index] has been added to Purchase#EstimateRequest. * contract_terms[action_at_term_end] has been added to Purchase#EstimateRequest. * contract_terms[cancellation_cutoff_period] has been added to Purchase#EstimateRequest. #### Deprecated input parameters: * product_created, product_updated, product_deleted, variant_created, variant_updated, variant_deleted has been deprecated in EventTypeEnum. ### v2.30.0(2024-02-29) * * * #### New attributes: * usage_percentage has been added to QuoteLineGroup resource. * usage_percentage has been added to Quote resource. * usage_percentage has been added to CreditNoteEstimate resource. * usage_percentage has been added to CreditNote resource. * usage_percentage has been added to InvoiceEstimate resource. * usage_percentage has been added to Invoice resource. * error_detail of type GatewayErrorDetail has been added to PaymentIntent#PaymentAttempt subResource. * origin_user has been added to Event resource. * proration_type has been added to QuotedSubscription#SubscriptionItem and Subscription#SubscriptionItem subResources * network_error_message, recommendation_message, processor_error_code, processor_error_message has been added to Transaction#GatewayErrorDetail subResource. #### New Enum values: * TAX_NOT_CONFIGURED_EXTERNAL_PROVIDER has been added to TaxExemptReasonEnum. #### New Input parameters: * billing_address has been added to Estimate#CreateSubItemForCustomerEstimateRequest. * transactions[amount] has been added to Invoice#ApplyPaymentsRequest. ### v2.29.0 (2024-01-31) * * * #### New Enum values: * item_price_entitlements_updated has been added to EventTypeEnum. * item_price_entitlements_removed has been added to EventTypeEnum. #### New Input parameters: * layout has been added to HostedPage#AcceptQuoteRequest in HostedPage resource. ### v2.28.0 (2024-01-04) * * * #### New resources: * Entitlements has been added. #### New attributes: * date_to, date_from, prorated_taxable_amount has been added to quote_line_group. * date_to, date_from, prorated_taxable_amount has been added to quote. * date_to, date_from, prorated_taxable_amount has been added to credit_note_estimate. * date_to, date_from, prorated_taxable_amount has been added to credit_note. * date_to, date_from, prorated_taxable_amount has been added to invoice_estimate. * date_to, date_from, prorated_taxable_amount has been added to order. * date_to, date_from, prorated_taxable_amount has been added to invoice. * active_id has been added to customers. * active_id has been added to subscriptions. * reference_id has been made optional for payment_sources/create_using_permanent_token * custom_payment_method_id has been added to transactions. * custom_payment_method_name has been added to transactions. * error_detail has been added to transactions. #### New Enum values: * CMR_FALABELLA, TARJETA_NARANJA, NATIVA, CENCOSUD, CABAL, ARGENCARD, ELO, HIPERCARD, CARNET, RUPAY, MAESTRO has been added to Card#CardTypeEnum * Transferred has been added to Subscription#StatusEnum. * Transferred has been added to SubscriptionEstimate#StatusEnum. * AutomatedBankTransfer has been added to PaymentMethodEnum. * UsAutomatedBankTransfer, GbAutomatedBankTransfer, EuAutomatedBankTransfer, JpAutomatedBankTransfer, MxAutomatedBankTransfer has been added to VirtualBankAccount#SchemeEnum. * CustomerBusinessEntityChanged, SubscriptionBusinessEntityChanged has been added to EventTypeEnum. * Dlocal has been added to GatewayEnum. * UsAutomatedBankTransfer, UkAutomatedBankTransfer, EuAutomatedBankTransfer, JpAutomatedBankTransfer, MxAutomatedBankTransfer, Custom has been added to OfflinePaymentMethodEnum. * AutomatedBankTransfer has been added to PaymentMethodEnum. * AutomatedBankTransfer has been added to PaymentMethodTypeEnum. #### New Input parameters: * custom_payment_method_name has been added to Transactions#RecordRefundRequest. * proration_type has been added to Subscription#UpdateForItemsRequest. * proration_type has been added to ItemPrice. * payment_initiator has been added to Invoice. * payment_method_token, customer_profile_token, network_transaction_id, mandate_id, skip_retrieval, card, billing_address has been added to PaymentSource#CreateUsingPermanentTokenRequest. * subscription_items[proration_type] has been added to Estimate#UpdateSubscriptionForItemsRequest. * transaction[custom_payment_method_id] has been added to Customer#RecordExcessPaymentRequest. * transaction[custom_payment_method_id] has been added to CreditNote#RecordRefundRequest. ### v2.27.0 (2023-11-30) * * * #### New Enum values: * swiss_reference has been added to PaymentReferenceNumber#TypeEnum. #### New Input parameters: * subscription[po_number] has been added to Quote#EditCreateSubForCustomerQuoteRequest in Quote resource. * subscription[po_number] has been added to Quote#EditCreateSubCustomerQuoteForItemsRequest in Quote resource. * * * ### v2.26.0 (2023-10-31) * * * #### New attributes: * statement_descriptor has been added to invoice resource. * source has been added to the Hosted_Pages resource. #### New Enum values: * pay_com has been added to Gateway. * pay_to, faster_payments, sepa_instant_transfer has been added to Customer#TypeEnum. * pay_to, faster_payments, sepa_instant_transfer has been added to PaymentMethodEnum. * pay_to, faster_payments, sepa_instant_transfer has been added to PaymentMethodTypeEnum. * pay_to, faster_payments, sepa_instant_transfer has been added to TypeEnum. * pay_to, faster_payments, sepa_instant_transfer, amazon_payments has been added to PaymentIntent#PaymentMethodTypeEnum. #### New Input parameters: * source has been added to HostedPage#CheckoutOneTimeForItemsRequest. * source has been added to HostedPage#CheckoutNewForItemsRequest. * source has been added to HostedPage#CheckoutExistingForItemsRequest. * statement_descriptor_descriptor has been added to Invoice#CreateRequest. * statement_descriptor_descriptor has been added to Invoice#CreateForChargeItemsAndChargesRequest. * statement_descriptor_descriptor has been added to Invoice#UpdateDetailsRequest. * statement_descriptor_additional_info has been added to Invoice#CreateRequest. * statement_descriptor_additional_info has been added to Invoice#CreateForChargeItemsAndChargesRequest. * statement_descriptor_additional_info has been added to Invoice#UpdateDetailsRequest. * statement_descriptor_descriptor has been added to Subscription#CreateRequest. * statement_descriptor_descriptor has been added to Subscription#CreateForCustomerRequest. * statement_descriptor_descriptor has been added to Subscription#CreateWithItemsRequest. * statement_descriptor_descriptor has been added to Subscription#UpdateRequest. * statement_descriptor_descriptor has been added to Subscription#UpdateForItemsRequest. * statement_descriptor_descriptor has been added to Subscription#ReactivateRequest. * statement_descriptor_additional_info has been added to Subscription#CreateRequest. * statement_descriptor_additional_info has been added to Subscription#CreateForCustomerRequest. * statement_descriptor_additional_info has been added to Subscription#CreateWithItemsRequest. * statement_descriptor_additional_info has been added to Subscription#UpdateRequest. * statement_descriptor_additional_info has been added to Subscription#UpdateForItemsRequest. * statement_descriptor_additional_info has been added to Subscription#ReactivateRequest. #### Updates to old parameters: * duration_type, discount_type in coupons has been made optional. * proration_type in addons is now supported. * csv_tax_rule has been removed. * Tax1JurisTypeEnum has been removed. * Tax2JurisTypeEnum has been removed. * Tax3JurisTypeEnum has been removed. * Tax4JurisTypeEnum has been removed. ### v2.25.0 (2023-09-26) * * * #### New attributes: * venmo has been added to the PaymentSource resource. * proration_type has been added to the QuotedCharge, QuotedSubscription and Subscription resource. #### New Enum values: * ebanx has been added to Gateway. * venmo has been added to Customer#TypeEnum. * venmo has been added to PaymentMethodEnum. * venmo has been added to PaymentMethodTypeEnum. * venmo has been added to TypeEnum. * venmo has been added to PaymentIntent#PaymentMethodTypeEnum. #### New Input parameters: * einvoicing_method has been added to HostedPage#CheckoutOneTimeForItemsRequest. * einvoicing_method has been added to HostedPage#CheckoutNewForItemsRequest. * additional_information has been added to PaymentSource#CardAdditionalInformation. ### v2.24.0 (2023-09-05) * * * #### New Resource: * CsvTaxRule has been added. #### New attributes: * direct_debit_scheme has been added to the PaymentSource#PaymentSourceBankAccount resource. #### New Enum : * DirectDebitSchemeEnum has been added. * Tax1JurisTypeEnum has been added. * Tax2JurisTypeEnum has been added. * Tax3JurisTypeEnum has been added. * Tax4JurisTypeEnum has been added. #### New Input parameters: * avalara_tax_code, hsn_code, taxjar_product_code has been added to Invoice#AddChargeRequest. ### v2.23.0 (2023-07-31) * * * #### New Attributes: * tax_category has been added to the CreditNote, Quote and Invoice resource. * proration_type has been added in Addon resource. #### New Enum values: * tax has been added to EntityType enum in Invoice resource. * payment_source_locally_deleted has been added to EventType. #### New Input parameters: * CouponId and CouponApplyTill has been added to Subscritpion#CreateRequest in Subscritpion resource. * CouponId and CouponApplyTill has been added to Subscritpion#CreateForCustomerRequest in Subscritpion resource. * CouponId and CouponApplyTill has been added to Subscritpion#CreateWithItemsRequest in Subscritpion resource. * CouponId and CouponApplyTill has been added to Subscritpion#UpdateRequest in Subscritpion resource. * CouponId and CouponApplyTill has been added to Subscritpion#UpdateForItemsRequest in Subscritpion resource. * CouponId and CouponApplyTill has been added to Subscritpion#ImportSubscriptionRequest in Subscritpion resource. * CouponId and CouponApplyTill has been added to Subscritpion#ImportForCustomerRequest in Subscritpion resource. * CouponId and CouponApplyTill has been added to Subscritpion#ImportForItemsRequest in Subscritpion resource. * cancel_reason_code has been added to Subscritpion#ImportForItemsRequest in Subscritpion resource. * proration_type has been added in addon#createRequest and addon#UpdateRequest in Addon resource. * addons[proration_type] has been added in Estimate#UpdateSubscriptionRequest in Estimate resource. * addons[proration_type] has been added in Subscription#UpdateRequest in Subscritpion resource. #### New Enum Class: * ProrationType enum has been added to addon resource. * ProrationType enum has been added. ### v2.22.0 (2023-06-30) * * * #### New endpoints: * ViewVoucher#ViewVoucherRequest has been added to the HostedPage resource. * InvoiceListPaymentReferenceNumbers#InvoiceListPaymentReferenceNumbersRequest has been added to the Invoice resource. #### New Resource: * PaymentReferenceNumber has been added. #### New attributes: * local_currency_exchange_rate has been added to the CreditNote and Invoice resource. #### New Enum values: * view_voucher has been added to Type enum in HostedPage resource. * paused has been added in StoreStatus enum in InAppSubscription resource. * metrics_global and windcave has been added in Gateway enum. #### New Input parameters: * payment_initiator has been added to Customers#CollectPaymentRequest. * payment_initiator has been added to Invoice#CreateRequest. * payment_initiator has been added to Invoice#ChargeRequest. * payment_initiator has been added to Invoice#ChargeAddonRequest. * payment_initiator has been added to Invoice#CollectPaymentRequest. * payment_initiator has been added to Subscription#CreateRequest. * payment_initiator has been added to Invoice#CreateForChargeItemRequest. * payment_initiator has been added to Subscription#CreateForCustomerRequest. * payment_initiator has been added to Subscription#CreateWithItemsRequest. * payment_initiator has been added to Subscription#UpdateForItemsRequest. * payment_initiator has been added to Subscription#ReactivateRequest. * payment_initiator has been added to Subscription#ResumeRequest. * payment_reference_numbers[id] has been added to Invoice#ImportInvoiceRequest. * payment_reference_numbers[type] has been added to Invoice#ImportInvoiceRequest. * payment_reference_numbers[number] has been added to Invoice#ImportInvoiceRequest. ### v2.21.0 (2023-05-31) * * * #### New endpoints: * PaymentSource#CreateVoucherPaymentSource has been added to the PaymentSource resource. * EventsRequest#HostedPage has been added to the PaymentSource resource. #### New Resource: * PaymentVoucher has been added. #### New attributes: * boleto and billing_address has been added to the PaymentSource resource. * product_id has been added to the ItemPrice resource. #### New Enum Class: * EventNameEnum has been added. * PaymentVoucherTypeEnum has been added. * VoucherTypeEnum has been added. #### New Enum values: * product and variant has been added to EntityType enum. * product_created, product_updated, product_deleted, variant_created, variant_updated and variant_deleted enums have been added in EventType enum. * voucher_created, voucher_expired and voucher_create_failed have been added in EventType enum. * boleto has been added in PaymentMethod and OfflinePaymentMethod and PaymentMethodTypeEnum#PaymentIntent. ### v2.20.0 (2023-05-16) * * * #### New Feature: * Added setIdempotencyKey("UUID") utility to pass **Idempotency key** along with request headers to allow a safe retry of POST requests. * Added isIdempotencyReplayed() utility to differentiate between original and replayed requests. * Added getResponseHeaders() utility to to fetch the response headers. ### v2.19.0 (2023-04-28) * * * #### Fixes: * SubscriptionId attribute has been maid as required in InAppSubscription resource. #### New Attributes: * TotalContractValueBeforeTax has been added to the ContractTerm resource. * TotalContractValueBeforeTax#SubscriptionContractTerm has been added to the Subscription resource. * TotalContractValueBeforeTax#SubscriptionEstimateContractTerm has been addded to the SubscriptionEstimate resource. * CouponConstraints has been added to the Coupon resource. #### New Resource: * NonSubscription have been added. #### Added Input Parameters: * contract_term[total_amount_raised_before_tax]#ImportSubscriptionRequest, contract_term[total_amount_raised_before_tax]#ImportForItemsRequest, contract_term[total_amount_raised_before_tax]#ImportContractTermRequest and contract_term[total_amount_raised_before_tax]#ImportForCustomerRequest parameter has been added to Subscription resource. * contract_term[total_contract_value_before_tax]#ImportContractTermRequest parameter has been added to Subscription resource. * coupon_constraints[entity_type]#CreateForItemsRequestParams, coupon_constraints[type]#CreateForItemsRequestParams and coupon_constraints[value]#CreateForItemsRequestParams parameter has been added to the Coupon resource. * coupon_constraints[entity_type]#UpdateForItemsRequestParams, coupon_constraints[type]#UpdateForItemsRequestParams and coupon_constraints[value]#UpdateForItemsRequestParams parameter has been added to the Coupon resource. * export_type#CustomersRequest and export_type#SubscriptionsRequest parameter has been added to the Export resource. #### New Enum Class: * ExportType has been added. #### New Enum values: * pending_authorization has been added to StatusEnum#PaymentIntentPaymentAttempt to the PaymentIntent resource. ### v2.18.0 (2023-03-24) * * * #### Fixes: * Fixed list_discounts subscriptions API error. #### New Attributes: * Einvoice#reference_number has been added to the credit_note resource. * Einvoice#reference_number has been added to the invoice resource. * einvoicing_method has been added to the customer resource. * store_status and invoice_id have been addded to the in_app_subscriptions resource. #### Added Input Parameters: * update_for_items_params#discount_quantity and update_params#discount_quantity parameter has been added to the coupon resource. * create_params#einvoicing_method and update_billing_info_params#einvoicing_method parameter has been added to the customer resource. * customer_create_params#einvoicing_method , customer_update_params#einvoicing_metho and customer_update_for_items_params#einvoicing_method parameter has been added to the Subscription resource. * subscription_info_create_params#meta_data parameter has been added to the purchase resource. #### New Endpoints: * credit_note#send_einvoice has been added to the CreditNote resource. * invoice#send_einvoice has been added to the Invoice resource. * in_app_subscriptions#import_subscription and in_app_subscriptions#retrieve_store_subs requests have been added to the in_app_subscriptions resource. #### New Enum Class: * EinvoicingMethod has been added. * StoreStatus has been added in in_app_subscriptions resource. ### v2.17.1 (2023-03-02) #### Fixes: * Fixed Subscription_Discount param parsing issue. ### v2.17.0 (2023-02-17) #### Fixes: * Fixed Serialization issue for invoice#business_entity_id, CreditNoteLineItem#entity_description CreditNoteEstimateLineItem#entity_description, InvoiceLineItem#entity_description, InvoiceEstimateLineItem#entity_description, QuoteLineItem#entity_description and QuoteLineGroupLineItem#entity_description attributes. #### New Attributes: * resource_version and updated_at parameter has been added to the tax_withheld resource. #### Added input parameters: * ListRequestParams#updated_at parameter has been added to attached_item resource. * attached_item_attached_items_params#updated_at parameter has been added to export resource. * CheckoutGiftRequestParams#coupon_ids parameter has been added to hosted_page resource. * customer_process_receipt_params#email, customer_process_receipt_params#first_name and customer_process_receipt_params#last_name parameters has been added to in_app_subscription resource. #### New endpoints: * invoice#record_tax_withheld and invoice#remove_tax_withheld has been added to the invoice resource. * credit_note#remove_tax_withheld_refund has been added to the credit_note resource. #### New Enum values: * custom has been added to payment_method Enum. * ecentric has been added to gateway Enum. #### Removed input parameters: * estimate_params#invoice_info_estimate_params parameter has been removed from purchase resource. #### Deprecated input parameters: * CheckoutGiftRequest#coupon parameter have been deprecated in hosted_page resource. ### v2.16.0 (2023-01-13) * * * #### New Attributes: * ShippingAddress and BillingAddress parameter has been added to the CreditNote. * is_advance_charge has been added to the UnbilledCharge. #### Added input parameters: * subscription_create_sub_for_customer_quote_params#po_number and subscription_create_sub_items_for_customer_quote_params#po_number parameter has been added to Quote resource. * unbilled_charges_import_unbilled_charges_params#is_advance_charge parameter has been added to Subscription resource. * import_invoice_params#has_advance_charges parameter has been added to Invoice resource. #### New endpoints: * Invoice#delete_line_items has been added to the Invoice resource. #### New Enum values: * SUBSCRIPTION_TRIAL_EXTENDED has been added to EventTypeEnum. * ZERO_VALUE_ITEM has been added to TaxExemptReasonEnum. * BANK_OF_AMERICA has been added to GatewayEnum. ### v2.15.0 (2022-11-21) * * * #### New Attributes: * business_entity_id filter parameter has been added to the Customer. * is_written_off, write_off_amount, write_off_date and credit_note parameter have been added to the Invoice. #### Added input parameters: * business_entity_id filter parameter has been added to the Export#revenue_recognition_params, Export#deferred_revenue_params, Export#customers_params and Subscription#subscription_list_params API. * skip_billing_cycles parameter has been added to the Estimate#subscription_pause_subscription_params API. * skip_billing_cycles parameter has been added to the Subscription#pause_params. * id have been added to the Invoices#credit_note_import_invoice_params API. #### New Enum values: * billing_cycles has been added to pause_option. ### v2.14.0 (2022-11-10) * * * #### New endpoints: * credit_notes#import_credit_note has been added to the credit_notes resource. * subscriptions#import_unbilled_charges has been added to the subscriptions resource. #### New attributes: * shipped_at parameter has been added to the orders#list_orders API. #### Added input parameters: * voided_at and void_reason_code have been added to the invoices#import_invoice API. #### New attributes: * business_entity_id has been added to the orders resource. #### New Enum values: * registered has been added to the status enum in credit_note_einvoice and invoice_einvoice subresources. * type enum has been added to the subscription_discount subresource. * subscription_entitlements_created has been added to the event_type enum. ### v2.13.0 (2022-09-20) #### New Resource: * discount has been added. #### New Enum values: * apply_on, duration_type and operation_type enums have been added. ### v2.12.0 (2022-09-20) * * * #### New endpoints: * subscriptions#list_discounts has been added to the subscriptions resource. #### New attributes: * billing_month has been added to the customer resource. #### Added input parameters: * billing_month has been added to the customers#change_billing_date API. * line_items[subscription_id] has been added to the invoices#import_invoice API. * layout has been added to hosted_pages#checkout_onetime_for_items, hosted_pages#checkout_new_for_items and hosted_pages#checkout_existing_for_items APIs. * discounts[apply_on], discounts[percentage], discounts[amount] and discounts[item_price_id] have been added to estimates#create_subscription_for_items, estimates#create_subscription_for_items_estimate, estimates#update_subscription_for_items, hosted_pages#checkout_onetime_for_items, hosted_pages#checkout_new_for_items, hosted_pages#checkout_existing_for_items, invoices#create_for_charge_items_and_charges, quotes#create_subscription_for_items, quotes#edit_create_subscription_quote_for_items, quotes#update_subscription_quote_for_items, quotes#edit_update_subscription_quote_for_items, quotes#create_for_charge_items_and_charges, quotes#edit_for_charge_items_and_charges, subscriptions#create_subscription_for_items, subscriptions#update_subscription_for_items and subscriptions#import_subscription_for_items APIs. * discounts[duration_type], discounts[period], discounts[period_unit] and discounts[included_in_mrr] have been added to estimates#create_subscription_for_items, estimates#create_subscription_for_items_estimate, estimates#update_subscription_for_items, hosted_pages#checkout_new_for_items, hosted_pages#checkout_existing_for_items, quotes#create_subscription_for_items, quotes#edit_create_subscription_quote_for_items, quotes#update_subscription_quote_for_items, quotes#edit_update_subscription_quote_for_items, subscriptions#create_subscription_for_items, subscriptions#update_subscription_for_items and subscriptions#import_subscription_for_items APIs. * discounts[operation_type] and discounts[id] have been added to estimates#update_subscription_for_items, quotes#update_subscription_quote_for_items, hosted_pages#checkout_existing_for_items, quotes#edit_update_subscription_quote_for_items, subscriptions#update_subscription_for_items and subscriptions#import_subscription_for_items APIs. #### New Enum values: * global_payments has been added to gateway enum. * layout enum has been added. ### v2.11.0 (2022-08-22) * * * #### New endpoints: * Purchase#Retrieve has been added to the Purchase resource. #### New attributes: * ResourceVersion has been added to the Token resource. * UpdatedAt has been added to the Token and UnbilledCharge resources. * ReferenceLineItemId has been added to the CreditNote#LineItem, CreditNoteEstimate#LineItem, Quote#LineItem, QuoteLineGroup#LineItem, InvoiceEstimate#LineItem and Invoice#LineItem subResources. * Index has been added to the Order#ShippingAddress, Invoice#ShippingAddress, Quote#ShippingAddress, QuotedCharge#ItemTier, QuotedSubscription#ItemTier, Subscription#ItemTier, Subscription#ShippingAddress and SubscriptionEstimate#ShippingAddress subResources. * VoidWithCreditNote has been added to the Invoice#VoidInvoiceRequest subresources. * PaymentMethodDetails has been added to the Transaction resource. #### New Resource: * InAppSubscription have been added. #### Removed input parameters: * BusinessEntityId has been removed from Purchase#CreateRequest and Purchase#EstimateRequest. ### v2.10.0 (2022-07-08) * * * ### Fixes: * Fixed Status Enum related issues * Fixed EmbeddedResource related issues #### New endpoints: * hostedpage#PreCancel has been added to the hostedpage resource. #### New attributes: * business_entity_id have been added to the CreditNote, Customer,HostedPage, Invoice, PaymentIntent, Quote, Subscription and Transaction resources. * coupon_set_code have been added to the CreditNote, CreditNoteEstimate, Invoice, InvoiceEstimate, Quote and QuoteLineGroup resources. * List of SubscriptionEstimate have been added to Estimate resource. #### New Resource: * ImpactedSubscription, ImpactedItem, Purchase have been added. #### New Enum values: * direct_debit has been added to payment_method_type enum. * bancontact, not_applicable added to payment_source_card_brand enum. * business_entity added to entity_type Enum * business_entity_created, business_entity_updated, business_entity_deleted, purchase_created added to event_type Enum * chargebee_payments added to gateway Enum ### v2.9.0 (2022-05-23) * * * #### New endpoints: * invoice#sync_usages and invoice#resend_einvoice have been added to the invoice resource. * credit_notes#resend_einvoice has been added to the credit_notes resource. * features#list_features, features#create_a_feature, features#update_a_feature, features#retrieve_a_feature, features#delete_a_feature, features#activate_a_feature, features#archive_a_feature and features#reactivate_a_feature have been added to the features resource. * subscription_entitlements#subscription_entitlements_for_subscription and subscription_entitlements#set_subscription_entitlement_availability have been added to the subscription_entitlements resource. * item_entitlements#item_entitlements_for_an_item, item_entitlements#item_entitlements_for_a_feature, item_entitlements#add_an_item_entitlements and item_entitlements#upsert_or_remove_an_item_entitlements_f