v4.27.0 (2026-09-24)
New Resources:
AppliedBusinessRulehas been added.AppliedRulehas been added.ApplyRulehas been added.BusinessRulehas been added.BusinessRulesethas been added.BusinessRulesetRulehas been added.CustomDataSchemahas been added.Disputehas been added.EmailLoghas been added.
New Actions:
send_credit_note_emailhas been added toCreditNote.send_payment_request_emailhas been added toCustomer.list_e-invoiceshas been added toEinvoice.retrieve_an_e-invoicehas been added toEinvoice.send_invoice_emailhas been added toInvoice.list_payment_scheduleshas been added toPaymentSchedule.list_payment_schedule_schemeshas been added toPaymentScheduleScheme.
New Attributes:
brand_idhas been added toCreditNote.brand_idhas been added toCustomer.entity_typehas been added toEinvoice.entity_idhas been added toEinvoice.created_athas been added toEinvoice.resource_versionhas been added toEinvoice.updated_athas been added toEinvoice.deletedhas been added toEinvoice.business_entity_idhas been added toEinvoice.artifactshas been added toEinvoice.site_idhas been added toEvent.provisioned_block_balancehas been added toGrantBlock.overdraft_block_balancehas been added toGrantBlock.brand_idhas been added toHostedPage.brand_idhas been added toInvoice.brand_idhas been added toPaymentIntent.reference_transactionshas been added toPaymentSchedule.brand_idhas been added toPaymentSource.network_transaction_referencehas been added toPaymentSource.billing_configurationhas been added toRamp.brand_idhas been added toSubscription.network_transaction_referencehas been added toThirdPartyPaymentMethod.network_transaction_detailshas been added toTransaction.
New Parameters:
limithas been added as query parameter tolist_e-invoicesinEinvoice.offsethas been added as query parameter tolist_e-invoicesinEinvoice.idhas been added as query parameter tolist_e-invoicesinEinvoice.reference_idhas been added as query parameter tolist_e-invoicesinEinvoice.updated_athas been added as query parameter tolist_e-invoicesinEinvoice.sort_byhas been added as query parameter tolist_e-invoicesinEinvoice.invoice_idhas been added as query parameter tolist_e-invoicesinEinvoice.credit_note_idhas been added as query parameter tolist_e-invoicesinEinvoice.limithas been added as query parameter tolist_payment_schedulesinPaymentSchedule.offsethas been added as query parameter tolist_payment_schedulesinPaymentSchedule.invoice_idhas been added as query parameter tolist_payment_schedulesinPaymentSchedule.idhas been added as query parameter tolist_payment_schedulesinPaymentSchedule.updated_athas been added as query parameter tolist_payment_schedulesinPaymentSchedule.limithas been added as query parameter tolist_payment_schedule_schemesinPaymentScheduleScheme.offsethas been added as query parameter tolist_payment_schedule_schemesinPaymentScheduleScheme.idhas been added as query parameter tolist_payment_schedule_schemesinPaymentScheduleScheme.updated_athas been added as query parameter tolist_payment_schedule_schemesinPaymentScheduleScheme.line_items.is_partial_tax_appliedhas been added as request body parameter toimport_credit_noteinCreditNote.line_items.taxable_amounthas been added as request body parameter toimport_credit_noteinCreditNote.brand_idhas been added as request body parameter tocreate_a_customerinCustomer.subscription_items.descriptionhas been added as request body parameter toestimate_for_creating_a_customer_and_subscriptioninEstimate.subscription_items.descriptionhas been added as request body parameter toestimate_for_updating_a_subscriptioninEstimate.subscription_items.descriptionhas been added as request body parameter toestimate_for_creating_a_subscriptioninEstimate.brand_idhas been added as request body parameter tocheckout_charge-items_and_one-time_chargesinHostedPage.brand_idhas been added as request body parameter toextend_subscriptioninHostedPage.brand_idhas been added as request body parameter tocheckout_gift_subscription_for_itemsinHostedPage.brand_idhas been added as request body parameter tocollect_nowinHostedPage.brand_idhas been added as request body parameter toaccept_a_quoteinHostedPage.brand_idhas been added as request body parameter tocreate_checkout_for_a_new_subscriptioninHostedPage.brand_idhas been added as request body parameter toclaim_a_gift_subscriptioninHostedPage.brand_idhas been added as request body parameter tocreate_checkout_to_update_a_subscriptioninHostedPage.brand_idhas been added as request body parameter tocreate_a_pre-cancel_hosted_pageinHostedPage.brand_idhas been added as request body parameter tomanage_payment_sourcesinHostedPage.line_items.is_partial_tax_appliedhas been added as request body parameter toimport_invoiceinInvoice.line_items.taxable_amounthas been added as request body parameter toimport_invoiceinInvoice.idhas been added as request body parameter toallocateinLedgerOperation.effective_fromhas been added as request body parameter toallocateinLedgerOperation.brand_idhas been added as request body parameter tocreate_a_payment_intentinPaymentIntent.brand_idhas been added as request body parameter tocreate_using_permanent_tokeninPaymentSource.brand_idhas been added as request body parameter tocreate_a_card_payment_sourceinPaymentSource.brand_idhas been added as request body parameter tocreate_using_payment_intentinPaymentSource.brand_idhas been added as request body parameter tocreate_a_voucher_payment_methodinPaymentSource.brand_idhas been added as request body parameter tocreate_using_gateway_temporary_tokeninPaymentSource.network_transaction_referencehas been added as request body parameter toupdate_a_card_payment_sourceinPaymentSource.brand_idhas been added as request body parameter tocreate_using_chargebee_tokeninPaymentSource.brand_idhas been added as request body parameter tocreate_a_bank_account_payment_sourceinPaymentSource.brand_idhas been added as request body parameter tocreate_pricing_page_for_new_subscriptioninPricingPageSession.idhas been added as request body parameter tocreate_promotional_grantinPromotionalGrant.effective_fromhas been added as request body parameter tocreate_promotional_grantinPromotionalGrant.billing_configurationhas been added as request body parameter tocreate_a_rampinRamp.billing_configurationhas been added as request body parameter toupdate_a_subscription_rampinRamp.subscription_items.descriptionhas been added as request body parameter toupdate_subscription_for_itemsinSubscription.brand_idhas been added as request body parameter tocreate_a_subscriptioninSubscription.brand_idhas been added as request body parameter tocreate_subscription_for_customerinSubscription.subscription_items.descriptionhas been added as request body parameter toimport_subscription_for_itemsinSubscription.subscription_items.descriptionhas been added as request body parameter tocreate_subscription_for_itemsinSubscription.brand_idhas been added as request body parameter tocreate_subscription_for_itemsinSubscription.
New Events:
business_rule_deletedhas been added.business_rules_appliedhas been added.business_ruleset_updatedhas been added.business_rule_createdhas been added.einvoice_createdhas been added.business_ruleset_deactivatedhas been added.business_ruleset_deletedhas been added.business_ruleset_createdhas been added.business_ruleset_activatedhas been added.business_rule_deactivatedhas been added.einvoice_updatedhas been added.business_rule_releasedhas been added.business_rule_activatedhas been added.business_rule_updatedhas been added.
New Enums:
business_rulesetandprice_ramphave been added as new values enumEntityType.einvoice_created,einvoice_updated,business_rule_created,business_rule_updated,business_rule_activated,business_rule_deactivated,business_rule_deleted,business_rule_released,business_rules_applied,business_ruleset_created,business_ruleset_updated,business_ruleset_activated,business_ruleset_deactivated, andbusiness_ruleset_deletedhave been added as new values enumEventType.payuhas been added as a new value enumGateway.payuhas been added as a new value enumGatewayName.blik,fpx,wero,p24,ovo,momo,mercado_pago,nequi,nupay,picpay,thai_qr,affirm_pay, andrakuten_payhave been added as new values enumPaymentMethod.ovo,momo,mercado_pago,nequi,nupay,picpay,thai_qr,blik,fpx,wero,p24,affirm_pay, andrakuten_payhave been added as new values enumPaymentMethodType.rescheduled,succeeded,failed,deferred,delivered,opened,bounced, anddroppedhave been added as new values enumStatus.zero_ratedhas been added as a new value enumTaxability.ovo,momo,mercado_pago,nequi,nupay,picpay,thai_qr,blik,fpx,wero,p24,affirm_pay, andrakuten_payhave been added as new values enumType.cpq_quotehas been added as a new value to enum attributeentity_typeinAppliedBusinessRule.stop_on_first_true,stop_on_first_false,execute_all, andexecute_all_truehave been added as new values to enum attributeexecute_modeinBusinessRuleset.activeandarchivedhave been added as new values to enum attributestatusinCustomDataSchema.initiated,funds_withdrawn,in_review,cancelled,lost, andwonhave been added as new values to enum attributestatusinDispute.chargebackandinquiryhave been added as new values to enum attributetypeinDispute.invoiceandcredit_notehave been added as new values to enum attributeentity_typeinEinvoice.overdraft_settlementhas been added as a new value to enum attributetypeinLedgerOperation.subscription_not_found_in_sourcehas been added as a new value to enum attributeexpiration_reasoninOmnichannelSubscriptionItem.ovo,momo,mercado_pago,nequi,nupay,picpay,thai_qr,blik,fpx,wero,p24,affirm_pay, andrakuten_payhave been added as new values to enum attributepayment_method_typeinPaymentIntent.ovo,momo,mercado_pago,nequi,nupay,picpay,thai_qr,blik,fpx,wero,p24,affirm_pay, andrakuten_payhave been added as new values to enum attributeactive_payment_attempt.payment_method_typeinPaymentIntent.trueandfalsehave been added as new values to enum query parameterdraft.isinlist_business_rulesofBusinessRule.trueandfalsehave been added as new values to enum query parameteractive.isinlist_business_rulesofBusinessRule.stop_on_first_true,stop_on_first_false,execute_all, andexecute_all_truehave been added as new values to enum request body parameterexecute_modeinupdate_a_business_rulesetofBusinessRuleset.trueandfalsehave been added as new values to enum query parameteractive.isinlist_rules_in_a_business_rulesetofBusinessRuleset.trueandfalsehave been added as new values to enum query parameteractive.isinlist_business_rulesetsofBusinessRuleset.stop_on_first_true,stop_on_first_false,execute_all, andexecute_all_truehave been added as new values to enum request body parameterexecute_modeincreate_a_business_rulesetofBusinessRuleset.dankorthas been added as a new value to enum request body parameterpreferred_schemeinupdate_card_for_a_customerofCard.dankorthas been added as a new value to enum request body parametercard.preferred_schemeincreate_a_customerofCustomer.dankorthas been added as a new value to enum request body parametercard.preferred_schemeincollect_payment_for_customerofCustomer.initiated,in_review,lost,funds_withdrawn,won, andcancelledhave been added as new values to enum query parameterstatus.isinlist_disputesofDispute.initiated,in_review,lost,funds_withdrawn,won, andcancelledhave been added as new values to enum query parameterstatus.is_notinlist_disputesofDispute.initiated,in_review,lost,funds_withdrawn,won, andcancelledhave been added as new values to enum query parameterstatus.ininlist_disputesofDispute.initiated,in_review,lost,funds_withdrawn,won, andcancelledhave been added as new values to enum query parameterstatus.not_ininlist_disputesofDispute.inquiryandchargebackhave been added as new values to enum query parametertype.isinlist_disputesofDispute.inquiryandchargebackhave been added as new values to enum query parametertype.is_notinlist_disputesofDispute.inquiryandchargebackhave been added as new values to enum query parametertype.ininlist_disputesofDispute.inquiryandchargebackhave been added as new values to enum query parametertype.not_ininlist_disputesofDispute.updated_athas been added as a new value to enum query parametersort_by.ascinlist_e-invoicesofEinvoice.updated_athas been added as a new value to enum query parametersort_by.descinlist_e-invoicesofEinvoice.dankorthas been added as a new value to enum request body parametercard.preferred_schemeincreate_an_invoiceofInvoice.dankorthas been added as a new value to enum request body parametercard.preferred_schemeincreate_invoice_for_items_and_one-time_chargesofInvoice.overdraft_settlementhas been added as a new value to enum query parametertype.isinlist_ledger_operationsofLedgerOperation.overdraft_settlementhas been added as a new value to enum query parametertype.ininlist_ledger_operationsofLedgerOperation.ovo,momo,mercado_pago,nequi,nupay,picpay,thai_qr,blik,fpx,wero,p24,affirm_pay, andrakuten_payhave been added as new values to enum request body parameterpayment_method_typeinupdate_a_payment_intentofPaymentIntent.ovo,momo,mercado_pago,nequi,nupay,picpay,thai_qr,blik,fpx,wero,p24,affirm_pay, andrakuten_payhave been added as new values to enum request body parameterpayment_method_typeincreate_a_payment_intentofPaymentIntent.dankorthas been added as a new value to enum request body parametercard.preferred_schemeincreate_a_card_payment_sourceofPaymentSource.dankorthas been added as a new value to enum request body parametercard.preferred_schemeinupdate_subscription_for_itemsofSubscription.dankorthas been added as a new value to enum request body parametercard.preferred_schemeincreate_a_subscriptionofSubscription.dankorthas been added as a new value to enum request body parametercard.preferred_schemeinupdate_a_subscriptionofSubscription.dankorthas been added as a new value to enum request body parametercard.preferred_schemeinimport_a_subscriptionofSubscription.
Deprecated Attributes:
granted_amounthas been deprecated inGrantBlock.balancehas been deprecated inGrantBlock.hold_amounthas been deprecated inGrantBlock.used_amounthas been deprecated inGrantBlock.expired_amounthas been deprecated inGrantBlock.rolled_over_amounthas been deprecated inGrantBlock.voided_amounthas been deprecated inGrantBlock.