API Changelog
API Changelog
Keep track of changes and upgrades to the Chargebee API. A chronology of changes to API v2 is listed below. Reach out to us at support@chargebee.com for any questions.
Here’s a snapshot about what we’ve been upto:
error_detail added to the
payment_intents resource.
origin_user added to the
events resource.
proration_type added to the
quoted_subscription.subscription_items , and
subscription.subscription_items resources.
network_error_message,
recommendation_message,
processor_error_code, and
processor_error_message added to the
transaction.error_detail resource.
tax_not_configured_external_provider to the enum
invoices.line_items.tax_exempt_reason .
billing_address added to the endpoint
create_subscription_for_items_estimate .
transactions[amount] added to the endpoint
apply_payments .
layout added to the endpoint
chargebee.credit_note.record_refund_for_a_credit_note .
item_price_entitlements_updated to the enum
events.event_types .
item_price_entitlements_removed to the enum
events.event_types .
entitlements.
proration_type added to the
item_price resource.
custom_payment_method_id added to the
transaction resource.
custom_payment_method_name added to the
transaction resource.
error_detail added to the
transaction resource.
date_to,
date_from, and
prorated_taxable_amount added to
quote_line_group.line_item_taxes ,
quote.line_item_taxes ,
credit_note_estimate.line_item_taxes ,
invoice_estimate.line_item_taxes ,
credit_note.line_item_taxes ,
order.line_item_taxes , and
invoice.line_item_taxes resources.
cmr_falabella,
tarjeta_naranja,
nativa,
cencosud,
cabal,
argencard,
elo,
hipercard,
carnet,
rupay, and
maestro to the enum
card.card_type .
transferred to the enum
subscription.subscription_status .
transferred to the enum
estimate.subscription_estimate_attributes.status .
automated_bank_transfer to the enums
transaction_attributes.payment_method , and
subscription.update_subscription_for_items.payment_method.type .
us_automated_bank_transfer,
gb_automated_bank_transfer,
eu_automated_bank_transfer,
jp_automated_bank_transfer, and
mx_automated_bank_transfer to the enum
virtual_bank_accounts.scheme .
customer_business_entity_changed and
subscription_business_entity_changed to the enum
event.list_events.event_type .
dlocal to the enum
payment_source.gateway .
us_automated_bank_transfer,
gb_automated_bank_transfer,
eu_automated_bank_transfer,, and
mx_automated_bank_transfer to the enum
subscription.update_subscription_for_items.offline_payment_method. .
reference_id has been made optional for the
chargebee.payment_source.create_using_permanent_token endpoint.
active_id,
customer_profile_token,
network_transaction_id,
mandate_id,
skip_retrieval,
card, and
billing_address added to the endpoint
chargebee.payment_source.create_using_permanent_token .
custom_payment_method_id added to the endpoint
chargebee.customer.record_excess_payment_for_a_customer .
proration_type added to the endpoint
chargebee.estimate.update_subscription_for_items .
proration_type added to the endpoint
chargebee.subscription.update_for_items .
custom_payment_method_id added to the endpoint
chargebee.credit_note.record_refund_for_a_credit_note .
payment_initiator added to the endpoint
chargebee.invoice.create_for_charge_items_and_charges .
proration_type added to the endpoint
chargebee.subscription.update_for_items .
swiss_reference to the enum
payment_reference_number.type .
subscription[po_number] added to the endpoint
POST/api/v2/quotes/{quote-id}/edit_create_subscription_quote_for_items .
subscription[po_number] added to the endpoint
POST/api/v2/quotes/{quote-id}/edit_create_subscription_quote .
statement_descriptor added to the
invoice resource.
pay_com to the enum
gateway .
pay_to,
faster_payments, and
sepa_instant_transfer to the enum
payment_source.type .
pay_to,
faster_payments, and
sepa_instant_transfer to the enum
payment_intent.payment_method_type .
pay_to,
faster_payments, and
sepa_instant_transfer to the enum
customer.payment_method.type .
pay_to,
faster_payments,
sepa_instant_transfer, and
amazon_payments to the enum
payment_source.payment_intent.payment_method_type .
statement_descriptor added to the endpoints
POST/api/v2/invoices ,
POST/api/v2/invoices/create_for_charge_items_and_charges ,
POST/api/v2/invoices/{invoice-id}/update_details ,
POST/api/v2/subscriptions ,
POST/api/v2/customers/{customer-id}/subscriptions ,
POST/api/v2/customers/{customer-id}/subscription_for_items ,
POST/api/v2/subscriptions/{subscription-id} ,
POST/api/v2/subscriptions/{subscription-id}/update_for_items , and
POST/api/v2/subscriptions/{subscription-id}/reactivate .
proration_type added to the
addon resource.
proration_type added to the endpoints -
POST/api/v2/addons and
POST/api/v2/addons/{addon-id} .
discount_type has been made optional for the endpoints -
POST/api/v2/coupons ,
GET/api/v2/coupons , and
POST/api/v2/coupons/{coupon-id} .
duration_type has been made optional for the endpoints -
POST/api/v2/coupons ,
GET/api/v2/coupons , and
POST/api/v2/coupons/{coupon-id} .
venmo added to
payment_source resource.
proration_type added to
quoted_charge ,
quoted_subscription , and
subscription resources.
ebanx to enum
gateway .
venmo to enum
customer.payment_method.type .
venmo to enum
payment_source.type .
venmo to enum
payment_intent.payment_method.type .
venmo to enum
payment_intent[payment_method_type ] .
card[additional_information] added to the
POST/api/v2/payment_sources/create_card endpoint.
customer[einvoicing_method] added to the
POST/api/v2/hosted_pages/checkout_new_for_items endpoint.
customer[einvoicing_method] added to the
POST/api/v2/hosted_pages/checkout_one_time_for_items endpoint.
direct_debit_scheme added to
payment_source resource.
avalara_tax_code added to the
POST/api/v2/invoices/create_for_charge_items_and_charges endpoint.
hsn_code added to the
POST/api/v2/invoices/create_for_charge_items_and_charges endpoint.
taxjar_product_code added to the
POST/api/v2/invoices/create_for_charge_items_and_charges endpoint.
tax added to the enum
invoice.notes.entity_type .
payment_source_locally_deleted added to the enum
event.event_type .
cancel_reason_code added to the
POST/api/v2/customers/{customer_id}/import_for_items endpoint.
POST/api/v2/hosted_pages/view_voucher .
GET/api/v2/invoices/payment_reference_numbers .
payment_reference_numbers.
local_currency_exchange_rate to the resources
invoices and
credit_notes.
view_voucher to enum
type .
paused to enum
store_status .
payment_initiator to endpoint:
Collect payment for customer .
payment_initiator to endpoint:
Collect payment for an invoice .
payment_initiator to endpoint:
Create an invoice .
payment_initiator to endpoint:
Create invoice for a one-time charge .
payment_initiator to endpoint:
Create invoice for a non-recurring addon .
payment_initiator to endpoint:
Collect subscription for items .
payment_initiator to endpoint:
Update subscription for items .
payment_initiator to endpoint:
Reactivate a subscription .
payment_initiator to endpoint:
Resume a subscription .
payment_initiator to endpoint:
Create subscription for customer .
payment_initiator to endpoint:
Create a subscription .
payment_reference_numbers[id] to endpoint:
Import invoice .
payment_reference_numbers[type] to endpoint:
Import invoice .
payment_reference_numbers[number] to endpoint:
Import invoice .
POST/api/v2/payment_sources/create_card .
POST/api/v2/hosted_pages/events .
payment_vouchers.
boleto and
billing_address to the resource
payment_source.
product_id to the resource
item_price.
voucher_type.
payment_voucher_type.
event_name.
product_created to enum
event_type .
product_updated to enum
event_type .
product_deleted to enum
event_type .
variant_created to enum
event_type .
variant_updated to enum
event_type .
variant_deleted to enum
event_type .
voucher_created to enum
event_type .
voucher_expired to enum
event_type .
voucher_create_failed to enum
event_type .
boleto to enums
payment_method_type and offline_payment_method .
chargebee-idempotency-key:<<UUID>> utility to pass Idempotency Key along with the request headers to allow safe retries of POST requests. The server uses this key to recognize and distinguish subsequent retries of the same request.
chargebee-idempotency-replayed utility to differentiate between the original and replayed requests. Users can identify a replay request by accessing the
chargebee-idempotency-replayed header, which will be set to
true during a replay.
total_contract_value_before_tax in resource
contract_term.
subscription_contract_term_total_contract_value_before_tax in resource
subscription.
estimate_contract_term_total_contract_value_before_tax in resource
estimate.
coupon_item_constraints_constraint in resource
coupon.
contract_term[total_amount_raised_before_tax] to endpoint:
Import subscription for Items .
contract_term[total_amount_raised_before_tax] to endpoint:
Import a subscription .
contract_term[total_amount_raised_before_tax] to endpoint:
Import contract term .
contract_term[total_amount_raised_before_tax] to endpoint:
Import subscription for customer .
contract_term[total_contract_value_before_tax] to endpoint:
Import contract term .
coupon_constraints[entity_type],
coupon_constraints[type], and
coupon_constraints[value] to endpoint:
Create a coupon for items .
coupon_constraints[entity_type],
coupon_constraints[type], and
coupon_constraints[value] to endpoint:
Update a coupon for items .
export_type to endpoint:
Export Customers .
export_type to endpoint:
Export Subscription .
pending_authorization to enum
status .
export_type.
credit_note_einvoice_reference_number in resource
credit_note.
invoice_einvoice_reference_number in resource
credit_note.
customer_einvoicing_method in resource
customer.
in_app_subscription_store_status and
in_app_subscription_invoice_id in resource
in_app_subscriptions.
einvoicing_method to endpoints:
Update billing info for a customer and
Create a customer.
einvoicing_method to endpoints:
Update subscription for items ,
Update a subscription , and
Create a subscription .
subscription_info[meta_data] to endpoint:
Create a purchase .
POST/api/v2/credit_notes/__demo_cn__1/send_einvoice .
POST/api/v2/invoices/__demo_inv__1/send_einvoice .
POST/api/v2/in_app_subscriptions/cb-pjp7hcmrcbfmtjhle3smlwicu4/import_receipt .
POST/api/v2/in_app_subscriptions/cb-pjp7hcmrcbfmtjhle3smlwicu4/retrieve .
is_advance_charge in resource
unbilled_charge.
updated_at to endpoint:
List attached items .
attached_item[updated_at] to endpoint:
Export Attached Items .
coupon_ids[0..n] to endpoint:
Checkout Gift subscription for Items .
customer[email],
customer[first_name], and
customer[last_name] to endpoint:
Process Purchase Command .
POST/api/v2/invoices/__demo_inv__4/record_tax_withheld and
POST/api/v2/invoices/__demo_inv__4/remove_tax_withheld .
POST/api/v2/credit_notes/__demo_cn__1/remove_tax_withheld_refund .
ecentric to enum
gateway .
EstimateRequest#invoice_info[po_number] and
EstimateRequest#invoice_info[notes] from
purchase resource.
CheckoutGiftRequest#subscription[coupon] in resource
hosted_page.
shipping_address and
billing_address in resource
credit_note.
is_advance_charge in resource
unbilled_charge.
subscription[po_number] to endpoint:
create_a_quote_for_a_new_subscription_items .
unbilled_charges[is_advance_charge] to endpoint:
import_unbilled_charges .
has_advance_charges to endpoint:
import_invoice .
POST/api/v2/invoices/__demo_inv__2/delete_line_items .
subscription_trial_extended to enum
event_type .
zero_value_item to enum
tax_exempt_reason .
bank_of_america to enum
gateway .
business_entity_id to endpoints:
list_customers ,
export_revenue_recognition_reports ,
export_deferred_revenue_reports ,
export_customers , and
list_subscriptions .
skip_billing_cycles to endpoint:
pause_a_subscription .
subscription[skip_billing_cycles] to endpoint:
pause_subscription_estimate .
is_written_off,
write_off_amount,
write_off_date, and
credit_note[id] to endpoint:
import invoices .
skip_billing_cycles to enum
pause_option .
POST/api/v2/credit_notes/import_credit_note .
POST/api/v2/subscriptions/import_unbilled_charges/import_unbilled_charges .
shipped_at in resource
order.
business_entity_id in resource
order.
type to enum
subscription_discounts_type .
subscription_entitlements_created to enum
event_type .
POST/api/v2/subscriptions .
billing_month in resource
customer.
billing_month to endpoint:
change_billing_date .
line_items[subscription_id] to endpoints:
change_billing_date .
layout to endpoint:
checkout_charge_items_and_one_time_charges ,
create_checkout_for_a_new_subscription , and
create_checkout_to_update_a_subscription .
discounts[apply_on],
discounts[amount],
discounts[item_price_id], and
discounts[percentage] to endpoints:
estimate_for_creating_a_customer_and_subscription ,
estimate_for_creating_a_subscription ,
estimate_for_updating_a_subscription ,
checkout_charge_items_and_one_time_charges ,
create_checkout_for_a_new_subscription ,
create_checkout_to_update_a_subscription
create_invoice_for_items_and_one-time_charges ,
create_a_quote_for_a_new_subscription_items ,
edit_create_subscription_quote_for_items ,
create_a_quote_for_update_subscription_items ,
edit_update_subscription_quote_for_items ,
create_a_quote_for_charge_and_charge_items ,
edit_quote_for_charge_items_and_charges ,
create_subscription_for_items ,
update_subscription_for_items , and
import_subscription_for_items .
discounts[included_in_mrr],
discounts[duration_type],
discounts[period], and
discounts[period_unit] to endpoints:
estimate_for_creating_a_customer_and_subscription ,
estimate_for_creating_a_subscription ,
estimate_for_updating_a_subscription ,
create_checkout_for_a_new_subscription ,
create_checkout_to_update_a_subscription ,
create_a_quote_for_a_new_subscription_items ,
edit_create_subscription_quote_for_items ,
create_a_quote_for_update_subscription_items ,
edit_update_subscription_quote_for_items ,
create_subscription_for_items ,
create_subscription_for_items ,
update_subscription_for_items , and
import_subscription_for_items .
discounts[operation_type] and
discounts[id] to endpoints:
estimate_for_updating_a_subscription ,
create_a_quote_for_update_subscription_items ,
create_subscription_for_items ,
create_subscription_for_items ,
update_subscription_for_items , and
import_subscription_for_items .
global_payments to enum
payment_source_gateway .
apply_on,
operation_type,
duration_type, and
layout.
resource_version in resource
token.
updated_at in resources
unbilled_charge and
token.
reference_line_item_id in sub-resources
credit_note_line_items,
credit_note_estimates.line_items,
quote_line_items,
quote_line_group.line_items,
invoice_estimate.line_items and
invoice_line_items.
index in sub-resources
order_shipping_address,
invoice_shipping_address,
quote_shipping_address,
quoted_charge_item_tiers,
quoted_subscription_item_tiers,
subscription_item_tiers,
subscription_shipping_address, and
estimate_shipping_address .
payment_method_details in resource
transaction.
in_app_subscriptions.
business_entity_id from endpoints:
create_a_purchase and
estimates_for_purchase .
POST/api/v2/hosted_pages/pre_cancel .
business_entity_id in resources
credit_note,
customer,
hosted_page,
payment_intent,
quote,
subscription, and
transaction.
discount.coupon_set_code in resources
credit_note,
credit_note,
credit_note_estimate,
invoice,
invoice_estimate,
quote_line_group, and
quote.
subscription_estimate.
purchase.
impacted_subscription.
impacted_items.
chargebee_payments to enum
payment_source_gateway .
business_entity_created,
business_entity_updated, and
business_entity_deleted to enum
event_types .
business_entity to enum
entity_type .
direct_debit to enum
payment_method_type .
feature.
subscription_entitlement.
item_entitlement.
entitlement_override.
POST/api/v2/invoices/{invoice_id}/sync_usages .
POST/api/v2/invoices/{invoice_id}/resend_einvoice .
POST/api/v2/credit_notes/{credit_note_id}/resend_einvoice .
GET/api/v2/features .
POST/api/v2/features .
POST/api/v2/features/{feature_id} .
GET/api/v2/features/{feature_id} .
POST/api/v2/features/{feature_id}/delete .
POST/api/v2/features/{feature_id}/activate_command .
POST/api/v2/features/{feature_id}/archive_command .
POST/api/v2/features/{feature_id}/reactivate_command .
GET/api/v2/subscriptions/{subscription_id}/subscription_entitlements .
POST/api/v2/subscriptions/{subscription_id}/subscription_entitlements/set_availability .
GET/api/v2/items/{item_id}/item_entitlements .
GET/api/v2/features/{feature_id}/item_entitlements .
POST/api/v2/features/{feature_id}/item_entitlements .
POST/api/v2/items/{item_id}/item_entitlements .
GET/api/v2/subscriptions/{subscription_id}/entitlement_overrides .
POST/api/v2/subscriptions/{subscription_id}/entitlement_overrides .
einvoice[status] to endpoint
list_credit_notes .
paypal_express_checkout to enum
payment_source.type .
current to enum
payment_source.bank_account.account_type .
feature_created,
feature_updated,
feature_deleted,
feature_activated,
feature_reactivated,
feature_archived,
item_entitlements_updated,
entitlement_overrides_updated,
entitlement_overrides_removed,
item_entitlements_removed, and
entitlement_overrides_auto_removed to enum
event_type .
GET/api/v2/unbilled_charges/create .
channel in resources:
addon,
attached_item,
credit_note,
customer,
invoice,
item_family,
item_price,
plan, and
subscription.
channel in resource
item.
external_name in resource
item.
channel to endpoint:
list_credit_notes .
channel to endpoint:
list_customers .
channel to endpoint:
list_addons .
channel to endpoint:
list_items .
channel to endpoint:
list_invoices .
channel to endpoint:
list_item_prices .
channel to endpoint:
list_plans .
channel to endpoint:
list_subscriptions .
credit_note[channel] to endpoint:
export_credit_notes .
customer[channel] to endpoint:
export_customers .
addon[channel] to endpoint:
export_addons .
item[channel] to endpoint:
export_items .
invoice[channel] to endpoint:
export_invoices .
item_price[channel] to endpoint:
export_item_prices .
plan[channel] to endpoint:
export_plans .
subscription[channel] to endpoint:
export_subscriptions .
invoice[channel],
subscription[channel], and
customer[channel] to endpoints:
export_revenue_recognition_reports and
export_deferred_revenue_reports .
item_family_id in endpoint:
create_an_item has been made a 'required' parameter.
coupon_expired from enum:
event_type.
net_term_days to endpoints:
create_subscription_for_items ,
update_subscription_for_items , and
import_subscription_for_items .
coupon in resource
hosted_pages.
upi,
mandates, and it's sub-attributes to resource
payment_sources.
bank_account[phone] to endpoint:
create_a_customer ,
create_an_invoice ,
create_invoice_for_items_and_one-time_charges ,
create_a_bank_account_payment_source ,
create_a_subscription .
payment_intent[payment_method_type] to endpoints:
collect_payment_intent ,
create_payment_intent ,
gift_subscription_estimate_for_items ,
create_a_gift_subscription_for_items ,
create_an_invoice ,
create_invoice_for_items_and_one-time_charges ,
create_using_payment_intent ,
create_subscription_for_items ,
update_subscription_for_items ,
reactivate_a_subscription ,
resume_a_subscriptions ,
create_a_subscription ,
create_subscription_for_customer , and
update_a_subscription .
customer[is_einvoice_enabled],
customer[entity_identifier_scheme],
customer[entity_identifier_standard],
entity_identifiers[id]],
entity_identifiers[scheme],
entity_identifiers[value],
entity_identifiers[operation],
entity_identifiers[standard] to endpoints:
gift_subscription &
gift_subscription_for_items .
subscription_id to endpoints:
list_payment_sources .
activated_at to endpoints:
import_subscription_for_items ,
import_a_subscription , and
import_subscription_for_customer .
upi and
netbanking_emandates to enum
payment_method[type] of resource
customer.
current to enum
bank_account[account_type].
quickbooks and
razorpay to enum
gateway.
upi and
netbanking_emandates to enum
payment_method,
payment_method_type, and
type.
upi,
netbanking_emandates and
apple_pay to enum
payment_method_type of resource
payment_intents.
current to enum
bank_account_type of resource
payment_sources.
NetdPaymentDueReminder in parameter
event_type.
GET/api/v2/credit_notes/{credit_note_id}/download_einvoice .
GET/api/v2/invoices/{invoice_id}/download_einvoice .
is_einvoice_enabled,
entity_identifier_scheme,
entity_identifier_standard, and
entity_identifiers to the resources
customer.
einvoiceto the resources
invoice.
einvoiceto the resources
credit_notes.
mime_typeto the resources
downloads.
einvoice.status to resource
credit_note.
user,
type,
payment_method, and
exchange_rate to resource
tax_withheld. Note: The attributes are only included in the resource when it is sent as part of the
content attribute in webhooks.
entity_identifier_scheme,
entity_identifier_standard,
is_einvoice_enabled,
entity_identifiers[id],
entity_identifiers[scheme],
entity_identifiers[value], and
entity_identifiers[standard] to endpoint:
create_a_customer and
update_billing_info_for_a_customer apis .
entity_identifiers[operation] to endpoint:
update_billing_info_for_a_customer apis .
customer[entity_identifier_scheme],
customer[entity_identifier_standard],
customer[is_einvoice_enabled],
entity_identifiers[id],
entity_identifiers[scheme],
entity_identifiers[value],
entity_identifiers[standard] to endpoint:
create_a_subscription api .
customer[entity_identifier_scheme],
customer[entity_identifier_standard],
customer[is_einvoice_enabled], to endpoint:
update_a_subscription and
update_subscription_for_items api.
hierarchy_operation_type for the endpoint
get_hierarchy .
create_pending_invoices from endpoint
list_subscriptions .
tax_withheld.
POST/api/v2/payment_sources/{cust_payment_source_id}/update_bank_account .
GET/api/v2/item_prices/{item_price_id}/applicable_items .
GET/api/v2/item_prices/{item_price_id}/applicable_item_prices .
hsn_code to the resources
addon,
item_price and
plan.
first_name,
last_name and
email to the resource
payment_sources.
hsn_code to endpoints:
POST/api/v2/addons ,
POST/api/v2/addons/{addon_id} ,
POST/api/v2/plans and
POST/api/v2/plans/{plan_id} .
bank_account[first_name],
bank_account[last_name], and
bank_account[email] to endpoint:
POST/api/v2/payment_sources/{cust_payment_source_id}/update_bank_account .
charges[hsn_code] to endpoints:
POST/api/v2/invoices ,
POST/api/v2/invoices/create_for_charge_items_and_charges ,
POST/api/v2/hosted_pages/checkout_one_time ,
POST/api/v2/hosted_pages/checkout_one_time_for_items ,
POST/api/v2/subscriptions/{subscription_id}/resume_subscription_estimate ,
POST/api/v2/estimates/create_invoice_for_items , and
POST/api/v2/unbilled_charges/invoice_unbilled_charges .
tax_detail[hsn_code] to endpoints:
POST/api/v2/item_prices and
POST/api/v2/item_prices/{item_price_id} endpoints.
subscription_activated_with_backdating,
tax_withheld_recorded,
tax_withheld_deleted, and
tax_withheld_refunded to enum
event_type.
entity_id to resource
order_line_item_discounts.
line_items[tax5_name],
line_items[tax5_amount],
line_items[tax6_name],
line_items[tax6_amount],
line_items[tax7_name],
line_items[tax7_amount],
line_items[tax8_name],
line_items[tax8_amount],
line_items[tax9_name],
line_items[tax9_amount],
line_items[tax10_name],
line_items[tax10_amount] to endpoint:
POST/api/v2/invoices/import_invoice .
replace_primary_payment_source to endpoints
POST/api/v2/customers/{customer_id}/subscriptions and
POST/api/v2/customers/{customer_id}/subscription_for_items .
coupon_expired to enum
event_type.
mollie to enum
gateway.
item_level_discount and
document_level_discount to enum
discount_type.
quoted_charge.
generated_at to resources
credit_note and
invoice.
change_option to resource
quoted_subscription.
changes_scheduled_at to resources
subscription and
quoted_subscription.
iin and
last4 to resource
transaction.
invoice_date to endpoints:
POST/api/v2/estimates/create_subscription ,
POST/api/v2/estimates/create_subscription_for_items ,
POST/api/v2/customers/{customer_id}/create_subscription_for_items_estimate ,
GET/api/v2/customers/{customer_id}/create_subscription_estimate ,
POST/api/v2/estimates/update_subscription ,
POST/api/v2/estimates/update_subscription_for_items ,
POST/api/v2/subscriptions/{subscription_id}/cancel_subscription_estimate ,
POST/api/v2/subscriptions/{subscription_id}/cancel_subscription_for_items_estimate ,
POST/api/v2/estimates/create_invoice_for_items,
POST/api/v2/estimates/create_invoice ,
POST/api/v2/hosted_pages/checkout_existing ,
POST/api/v2/hosted_pages/checkout_existing_for_items ,
POST/api/v2/invoices ,
POST/api/v2/invoices/create_for_charge_items_and_charges ,
POST/api/v2/subscriptions ,
POST/api/v2/customers/{customer_id}/subscriptions ,
POST/api/v2/subscriptions/{subscription_id} ,
POST/api/v2/customers/{customer_id}/subscription_for_items ,
POST/api/v2/subscriptions/{subscription_id}/update_for_items ,
POST/api/v2/subscriptions/{subscription_id}/reactivate ,
POST/api/v2/subscriptions/{subscription_id}/cancel_for_items , and
POST/api/v2/subscriptions/{subscription_id}/cancel .
coupon_ids to endpoints:
POST/api/v2/invoices/charge ,
POST/api/v2/invoices/charge_addon,
POST/api/v2/quotes/create_for_onetime_charges ,
POST/api/v2/quotes/{quote_id}/edit_one_time_quote ,
POST/api/v2/quotes/create_for_charge_items_and_charges , and
POST/api/v2/quotes/{quote_id}/edit_for_charge_items_and_charges .
change_option and
changes_scheduled_at to endpoints:
POST/api/v2/quotes/update_subscription_quote ,
POST/api/v2/quotes/{quote_id}/edit_update_subscription_quote ,
POST/api/v2/quotes/update_subscription_quote_for_items ,
POST/api/v2/quotes/{quote_id}/edit_update_subscription_quote_for_items ,
POST/api/v2/subscriptions/{subscription_id}/cancel_subscription_estimate , and
POST/api/v2/customers/{customer_id}/subscription_for_items .
invoice_date,
create_pending_invoices, and
first_invoice_pending to endpoint
POST/api/v2/quotes/{quote_id}/convert .
subscription[auto_close_invoices] to endpoint
POST/api/v2/quotes/{quote_id}/convert .
subscription_cancel to enum
charge_event in resource
quote_line_groups.
subscription_created_with_backdating,
subscription_changed_with_backdating,
subscription_canceled_with_backdating,
subscription_reactivated_with_backdating,
invoice_generated_with_backdating, and
credit_note_created_with_backdating to enum
event_type
coupon in endpoints
invoices#create_invoice_for_a_one-time_charge and
invoices#create_invoice_for_a_non-recurring_addon.
hosted_pages.
orders.
quotes.
accounting_category3 and
accounting_category4 for resources
addon,
item_price and
plan.
quantity_in_decimal to resource
attached_item.
period and
period_unit to resource
coupon.
line_item_discounts.entity_id to resources
credit_note,
credit_note_estimate,
invoice,
invoice_estimate,
quote and
quote_line_group.
vat_number_prefix to resources
credit_note,
customer,
invoice and
quote.
price_in_decimal to resources
differential_price and
item_price.
exchange_rate and
new_sales_amount to resources
invoice.
archived_at to resources
item and
item_price.
trial_end_action to resources
item_price,
plan,
subscription, and
subscription_estimate.
resent_orders,
tracking_url,
resent_status,
is_resent,
original_order_id, and
resend_reasons to resource
order.
line_item_tiers to resource
quote.
plan_quantity_in_decimal, and
plan_unit_price_in_decimal to resources
quoted_subscription and
subscription.
contract_term_billing_cycle_on_renewal and
quoted_contract_term to resource
quoted_subscription.
quantity_in_decimal,
metered_quantity,
last_calculated_at,
unit_price_in_decimal,
amount_in_decimal, and
free_quantity_in_decimal to object
subscription_items of resources
quoted_subscription and
subscription.
cancel_schedule_created_at to resource
subscription.
exchange_rate and
merchant_reference_id to resource
transaction.
accounting_category3 and
accounting_category4 to endpoints
create_an_addon ,
update_an_addon ,
create_a_plan , and
update_a_plan .
quantity_in_decimal to endpoints
create_an_attached_item ,
update_an_attached_item , and
create_a_gift_subscription_for_items .
period and
period_unit to endpoints
create_a_coupon ,
update_a_coupon ,
create_a_coupon_for_items , and
update_a_coupon_for_items .
vat_number_prefix to endpoints
create_a_customer ,
update_billing_info_for_a_customer ,
create_subscription ,
create_subscription_estimate ,
create_subscription_for_items ,
create_subscription_for_items_estimate ,
update_subscription_for_items_estimate ,
update_subscription ,
checkout_new_subscription ,
checkout_one-time_payments ,
create_checkout_for_a_new_subscription ,
checkout_existing_subscription ,
create_checkout_to_update_a_subscription ,
import_invoice ,
update_invoice_details ,
create_a_subscription ,
update_a_subscription ,
update_subscription_for_items , and
import_a_subscription .
payment_method[additional_information] to endpoints
create_a_customer ,
update_payment_method_for_a_customer ,
collect_payment_for_customer ,
create_an_invoice ,
create_invoice_for_items_and_one-time_charges ,
create_a_subscription ,
update_a_subscription ,
update_subscription_for_items , and
import_a_subscription endpoints.
card[additional_information] to endpoints
create_a_customer ,
collect_payment_for_customer ,
create_an_invoice ,
create_invoice_for_items_and_one-time_charges ,
create_a_card_payment_source ,
create_a_subscription ,
update_a_subscription ,
update_subscription_for_items , and
import_a_subscription endpoints.
bank_account[billing_address] to endpoints
create_a_customer ,
create_an_invoice ,
create_invoice_for_items_and_one-time_charges ,
Create bank account payment source , and
create_a_subscription endpoints.
price_in_decimal to endpoints
create_a_differential_price , and
update_a_differential_price endpoints.
tiers[starting_unit_in_decimal[0..N]],
tiers[ending_unit_in_decimal[0..N]] and
tiers[price_in_decimal[0..N]] to endpoints
create_a_differential_price ,
update_a_differential_price ,
create_an_item_price , and
update_an_item_price endpoints.
remove_general_note and
notes_to_remove to endpoints
create_invoice_estimate ,
create_invoice_for_items_estimate , and
create_invoice_for_items_and_one-time_charges .
trial_end_action to endpoints
create_subscription_estimate ,
create_subscription_for_items ,
create_subscription_for_items_estimate ,
update_subscription_for_items ,
update_subscription ,
create_a_plan ,
update_a_plan ,
create_an_item_price ,
update_an_item_price ,
create_a_subscription , subscriptions#create_subscription_for_customer,
create_subscription_for_items ,
update_a_subscription , and
update_subscription_for_items .
subscription_items[unit_price_in_decimal[0..N]],
item_tiers[starting_unit[0..N]],
item_tiers[ending_unit[0..N]], and
item_tiers[price_in_decimal[0..N]] to endpoints
create_subscription_for_items ,
create_subscription_for_items_estimate ,
update_subscription_for_items ,
update_subscription ,
cancel_subscription_for_items_estimate ,
hosted_pages#create_checkout_for_a_new_subscription ,
create_checkout_to_update_a_subscription ,
create_subscription_for_items ,
update_subscription_for_items , and
import_subscription_for_items .
subscription_items[quantity_in_decimal[0..N]] to endpoints
create_subscription_for_items ,
create_subscription_for_items_estimate ,
cancel_subscription_for_items_estimate ,
update_subscription_for_items ,
update_subscription , estimates#gift_subscription_for_items,
cancel_subscription_for_items_estimate ,
create_a_gift_subscription_for_items ,
hosted_pages#create_checkout_for_a_new_subscription ,
create_checkout_to_update_a_subscription ,
create_subscription_for_items ,
update_subscription_for_items ,
import_subscription_for_items , and
cancel_subscription_for_items .
notes_to_remove[entity_type[0..N]] and
notes_to_remove[entity_id[0..N]], to endpoints
create_invoice_estimate ,
create_invoice_for_items , and
create_invoice_for_items_and_one-time_charges endpoints.
item_prices[quantity_in_decimal[0..N]] and
item_prices[unit_price_in_decimal[0..N]] to endpoints
create_invoice_for_items ,
create_invoice_for_items_and_one-time_charges , and
create_unbilled_charges_for_a_subscription .
item_tiers[starting_unit_in_decimal[0..N]],
item_tiers[ending_unit_in_decimal[0..N]], and
item_tiers[price_in_decimal[0..N]] to endpoints
create_invoice_for_items ,
create_invoice_for_items_and_one-time_charges , and
create_unbilled_charges_for_a_subscription .
payment_intent[additional_information] to endpoints
create_a_customer ,
collect_payment_for_customer ,
create_a_gift_subscription_for_items ,
create_a_gift , and
create_using_payment_intent .
allow_offline_payment_methods to endpoints
create_checkout_for_a_new_subscription and
create_checkout_to_update_a_subscription .
free_quantity_in_decimal,
price_in_decimal, and
trial_end_action to endpoints in
create_an_item_price and
update_an_item_price .
tracking_url to endpoints
create_an_order ,
update_an_order , and
import_an_order .
additional_information to endpoints
create_using_gateway_temporary_token and
create_using_permanent_token .
resent_status,
is_resent, and
original_order_id to endpoints
exports#orders and
list_orders .
usage_date to endpoint
list_usage .
duration_month in resource
coupon.
bancontact to enum
card_type.
card and
latam_local_card to enum
powered_by.
item_level_discount and
document_level_discount to enum
entity_type of resources
credit_note_discount,
credit_note_estimate_discount,
invoice_discount,
line_item_discount and
invoice_estimate_discount.
item_level_discount and
document_level_discount to enum
discount_type.
add_usages_reminder and
order_resent have been added to
event_type enum.
ingenico_direct and
exact have been added to
gateway enum.
max_usage has been added to
usage_calculation enum.
order_resent to enum
cancellation_reason.
custom_discount to enum
discount_type of resource
order_line_item_discount.
trial_end_action enum has been added.
resent_status enum has been added.
usages is added.
hosted_pages resource.
auto_close_invoices has been added in
customers and
subscriptionsresource.
metered and
usage_calculation has been added to
itemsresource.
create_pending_invoices and
auto_close_invoices has been added to
subscriptionsresource.
auto_close_invoices has been added to the endpoint
create_a_customer ,
list_customers ,
update_a_customer .
invoice_allocations[invoice_id] has been added to the endpoint
collect_payment_for_customer .
coupon_ids has been added to the endpoint
create_invoice_for_items_estimate
subscription[auto_close_invoices] has been added to the endpoint
export_revenue_recognition_reports ,
export_deferred_revenue_reports and
export_subscriptions
customer[auto_close_invoices] has been added to the endpoint
export_revenue_recognition_reports and
export_deferred_revenue_reports and
export_customers
customer[auto_close_invoices] has been added to the endpoint
export_items .
subscription_id has been added to the endpoint
add_one-time_charge_to_a_pending_invoice and
add_non-recurring_addon_to_a_pending_invoice .
subscription_id has been added to the endpoint
add_a_charge-item_to_a_pending_invoice .
metered and
usage_calculation have been added to the endpoint
create_an_item and
list_item .
create_pending_invoices
auto_close_invoices and
first_invoice_pendinghave been added to the endpoints
create_subscription_for_items ,
update_subscription_for_items and
import_subscription_for_items .
create_pending_invoices and
auto_close_invoices have been added to the endpoint
list_subscriptions .
estimate resource.
estimate resource
gifts resource.
subscriptions resource.
show_description_in_invoices,
show_description_in_quotes have been added to the
resource.
tiers[starting_unit_in_decimal],
tiers[ending_unit_in_decimal],
tiers[price_in_decimal] have been added to the resource
differential_prices.
show_description_in_invoices,
show_description_in_quotes have been added to the resource
item_prices.
payment_intent[additional_info] has been added to the endpoints
reate_a_customer ,
create_an_invoice ,
create_using_payment_intent ,
create_a_subscription ,
update_a_subscription ,
create_subscription_for_customer ,
reactivate_a_subscription ,
resume_a_subscription .
payment_intent[additional_info has been added to the endpoints
create_a_gift_subscription_for_items ,
create_invoice_for_items_and_one-time_charges ,
create_subscription_for_items ,
update_subscription_for_items .
contract_term[action_at_term_end,
contract_term[cancellation_cutoff_period],
subscription[contract_term_billing_cycle_on_renewal] has been added to the endpoint
estimate_for_creating_a_subscription .
cancel_at,
contract_term_cancel_option,
cancel_reason_code have been added to the endpoint
cancel_subscription_for_items_estimate .
event_based_addons has been added to the endpoint
cancel_subscription_for_items_estimate .
redirect_url has been added to the endpoint
accept_a_quote .
token_id,
retain_payment_source,
card,,
payment_method added have been added to the endpoint
create_an_invoice .
token_id,
retain_payment_source,
card,,
payment_method have been added to the endpoint
create_invoice_for_items_and_one-time_charges .
show_description_in_invoices,
show_description_in_quotes have been added to the endpoints
create_an_item_price ,
update_an_item_price .
price_in_decimal,
tiers[starting_unit_in_decimal],
tiers[ending_unit_in_decimal],
tiers[price_in_decimal] have been added to the resource
addon.
price_in_decimal,
tiers[starting_unit_in_decimal],
tiers[ending_unit_in_decimal],
tiers[price_in_decimal] have been added to
create_an_addon and
update_an_addon .
unit_amount_in_decimal,
quantity_in_decimal,
amount_in_decimal,
line_item_tiers[starting_unit_in_decimal],
line_item_tiers[ending_unit_in_decimal],
line_item_tiers[quantity_used_in_decimal],
line_item_tiers[unit_amount_in_decimal] have been added to the resources
credit_note,
credit_note_estimate,
invoice,
invoice_estimate.
line_items[unit_amount_in_decimal],
line_items[quantity_in_decimal] have been added to
create_credit_note api.
subscription[plan_unit_price_in_decimal],
subscription[plan_quantity_in_decimal],
addons[quantity_in_decimal],
addons[unit_price_in_decimal],
event_based_addons[quantity_in_decimal],
event_based_addons[unit_price_in_decimal] have been added to
create_subscription_estimate ,
create_subscription_for_a_customer_estimate ,
update_subscription_estimate ,
checkout_new_subscription ,
checkout_existing_subscription ,
create_a_quote_for_a_new_subscription ,
edit_create_subscription_quote ,
create_a_quote_for_update_subscription ,
edit_update_subscription_quote apis.
subscription[plan_quantity_in_decimal],
addons[quantity_in_decimal] have been added to
gift_subscription_estimate ,
create_a_gift ,
checkout_gift_subscription apis.
addons[quantity_in_decimal],
addons[unit_price_in_decimal],
charges[amount_in_decimal] have been added to
create_invoice_estimate ,
create_an_invoice ,
create_a_quote_for_one-time_charges ,
edit_one-time_quote apis.
amount_in_decimal has been added to
create_invoice_for_a_one-time_charge api.
amount has been made optional to
create_invoice_for_a_one-time_charge api.
addon_quantity_in_decimal,
addon_unit_price_in_decimal have been added to
create_invoice_for_a_non-recurring_addon .
line_items[unit_amount_in_decimal],
line_items[quantity_in_decimal],
line_items[amount_in_decimal],
line_item_tiers[starting_unit_in_decimal],
line_item_tiers[ending_unit_in_decimal],
line_item_tiers[quantity_used_in_decimal],
line_item_tiers[unit_amount_in_decimal] have been added to
import_invoice api.
line_item_tiers[starting_unit],
line_item_tiers[ending_unit],
line_item_tiers[quantity_used],
line_item_tiers[unit_amount] have beed made optional in
import_invoice api.
addon_quantity_in_decimal,
addon_unit_price_in_decimal have been added to
add_non-recurring_addon_to_a_pending_invoice api.
tiers[starting_unit_in_decimal],
tiers[ending_unit_in_decimal],
tiers[price_in_decimal],
attached_addons[quantity_in_decimal],
event_based_addons[quantity_in_decimal],
free_quantity_in_decimal,
price_in_decimal have been added to the resource
plan.
tiers[starting_unit_in_decimal],
tiers[ending_unit_in_decimal],
tiers[price_in_decimal],
attached_addons[quantity_in_decimal],
event_based_addons[quantity_in_decimal],
free_quantity_in_decimal,
price_in_decimal have been added to
update_a_plan and
create_a_plan apis.
amount_in_decimal has been added to the resource
promotional_credit.
amount_in_decimal has been added to
add_promotional_credits ,
deduct_promotional_credits ,
set_promotional_credits apis.
unit_amount_in_decimal,
quantity_in_decimal,
amount_in_decimal have been added to the resource
quote
addons[quantity_in_decimal],
addons[unit_price_in_decimal],
addons[amount_in_decimal],
event_based_addons[quantity_in_decimal],
event_based_addons[unit_price_in_decimal] have been added to the sub resource
quoted_subscription
unit_amount_in_decimal,
quantity_in_decimal,
amount_in_decimal have been added to the sub resource
quoted_line_group
addons[quantity_in_decimal],
addons[unit_price_in_decimal],
addons[amount_in_decimal],
event_based_addons[quantity_in_decimal],
event_based_addons[unit_price_in_decimal],
plan_free_quantity_in_decimal,
plan_quantity_in_decimal,
plan_unit_price_in_decimal,
plan_amount_in_decimal have been added to the resource
subscription
plan_unit_price_in_decimal,
plan_quantity_in_decimal,
addons[quantity_in_decimal],
addons[unit_price_in_decimal],
event_based_addons[quantity_in_decimal],
event_based_addons[unit_price_in_decimal] have been added to
create_a_subscription ,
create_subscription_for_customer ,
update_a_subscription ,
import_a_subscription ,
import_subscription_for_customer apis.
amount_in_decimal has been added to
add_charge_at_term_end apis.
amount has been made optional in
add_charge_at_term_end apis.
addon_quantity_in_decimal,
addon_unit_price_in_decimal have been added to
charge_addon_at_term_end api
tiers[starting_unit_in_decimal],
tiers[ending_unit_in_decimal],
tiers[quantity_used_in_decimal],
tiers[unit_amount_in_decimal],
unit_amount_in_decimal,
quantity_in_decimal,
amount_in_decimal have been added to the resource
unbilled_charge.
transaction
quoted_subscriptions has been added to the resource
quote.
resource_version and
updated_at are added to the resource
payment_intent.
included_in_mrr has been added in addon and coupon resource
offline_payment_method has been added in subscription and customer resource
included_in_mrr has been added in
create_an_addon ,
update_an_addon ,
create_a_coupon and
update_a_coupon apis.
offline_payment_method has been added in
create_a_customer ,
list_customers ,
update_a_customer ,
create_a_subscription ,
create_subscription_for_customer and
list_subscriptions apis
auto_collection has been added in
update_a_subscription
subscription[offline_payment_method] has been added in
create_subscription_estimate ,
create_subscription_for_a_customer_estimate ,
update_subscription_estimate ,
export_revenue_recognition_reports ,
export_deferred_revenue_reports ,
export_subscriptions ,
checkout_new_subscription and
checkout_existing_subscription apis
subscription[auto_collection] has been added in
checkout_existing_subscription and
update_subscription_estimate apis
customer[offline_payment_method] has been added in
export_revenue_recognition_reports ,
export_deferred_revenue_reports ,
export_customers and
create_a_subscription
currency_code is added in
list_addons ,
list_coupons ,
list_plans ,
export_plans ,
export_addons ,
export_coupons apis
powered_by has been added in card resource
subscription[free_period],
subscription[free_period_unit] have been added in
create_subscription_estimate ,
create_subscription_for_a_customer_estimate ,
update_subscription_estimate apis
invoice[customer_id] is made optional in
create_invoice_estimate api
customer_id is made optional in
create_an_invoice api
created_at in dunning_attempts sub resource is made optional in the invoice resource
free_period and
free_period_unit have been added in the Subscription resource
free_period_unit has been added with the values:
DAY,
WEEK,
MONTH,
YEAR
powered_by has been added in card resource with the values:
IDEAL,
SOFORT,
BANCONTACT,
GIROPAY,
NOT_APPLICABLE
status,
amount and
date in the linked_payment sub resource are made optional in the transaction resource
GIROPAY and
DOTPAY have been added to the
payment_method_types enum
PAYMENT_SOURCE_EXPIRING and
PAYMENT_SOURCE_EXPIRED have been added to the
event_type enums
PAYPAL has been added to the
gateway enum
show_description_in_invoices,
show_description_in_quotes have been added in Addon, Plan resource
show_description_in_invoices,
show_description_in_quotes have been added for
create_an_addon ,
update_an_addon ,
create_a_plan ,
update_a_plan apis
create_reason_code has been added in Credit notes resource
reason_code is made optional in the Credit notes resource
create_reason_code is added in
list_credit_notes api
refund_reason_code has been added in Credit notes' Refund, Record a refund apis
parent_account_access and
child_account_access have been added in Customer resource
use_default_hierarchy_settings has been added in Customer resource
use_default_hierarchy_settings,
parent_account_access,
child_account_access have been added in
link_a_customer api
invoice_notes,
coupon_ids,
invoice[subscription_id],
charges[taxable],
charges[tax_profile_id],
charges[avalara_tax_code],
charges[taxjar_product_code] has been added to
create_invoice_estimate api
cancel_reason_code has been added to
export_revenue_recognition_reports ,
export_deferred_revenue_reports ,
export_subscriptions ,
export_credit_notes apis
coupon_ids has been added to
checkout_new_subscription ,
checkout_existing_subscription apis
subscription_coupon has been deprecated in
checkout_new_subscription ,
checkout_existing_subscription apis
void_reason_code has been added to the Invoice resource
cn_reason_code has been made optional in applied_credits, adjustment_credit_notes, issued_credit_notes, linked_credit_note sub-resources
cn_create_reason_code has been added in applied_credits, adjustment_credit_notes, issued_credit_notes, linked_credit_note sub-resources
subscription_id,
invoice_note,
remove_general_note,
coupon_ids,
charges[code],
charges[code],
charges[code],
charges[code] have been added to
create_an_invoice api
coupon is deprecated from
create_an_invoice api
void_reason_code has been added to
list_invoices api
invoice_note,
remove_general_note,
notes_to_remove[code],
notes_to_remove[code] have been added to
close_a_pending_invoice api
void_reason_code has been added to
void_an_invoice api
credit_note[code] has been added to
refund_an_invoice ,
record_refund_for_an_invoice api
exclude_deleted_credit_notes has been added to
list_orders api
payment_method_type has been added to payment_intent resource and active_payment_attempt sub-resource
payment_method_type has been added to
create_a_payment_intent ,
update_a_payment_intent api
version,
contract_term_start,
contract_term_end,
contract_term_termination_fee have been added to Quotes resource
contract_term[code],
contract_term[code],
subscription[code] have been added to
create_a_quote_for_a_new_subscription ,
create_a_quote_for_update_subscription apis
version has been added to quote_line_group sub-resource
cancel_reason_code has been added to Subscriptions resource
cancel_reason_code has been added to
list_subscriptions ,
cancel_a_subscription apis
contract_term_billing_cycle_on_renewal has been added to
import_a_subscription ,
import_subscription_for_customer apis
event_based_addon has been added to
cancel_a_subscription api
is_voided has been added to
list_unbilled_charges api
MRR_UPDATED,
ORDER_DELETED have been added
SOFORT,
BANCONTACT have been added to the payment_method_types enum
entity_type_description has been added to the line_items sub-resource
contract_term_billing_cycle_on_renewal,
contract_term[action_at_term_end],
contract_term[cancellation_cutoff_period] has been added in create_a_subscription, create_subscription_for_customer, update_a_subscription and reactivate_a_subscription apis
contract_term_cancel_option has been added in cancel_a_subscription api
contract_term[action_at_term_end],
contract_term[cancellation_cutoff_period],
subscription[contract_term_billing_cycle_on_renewal] has been added in create_subscription_estimate, create_subscription_for_a_customer_estimate, checkout_new_subscription, checkout_existing_subscription apis
business_customer_without_vat_number has been added in create_a_customer and update_billing_info_for_a_customer apis
addons[service_period] replaces the parameter
addons[date_from] and
addons[date_to] in create_a_quote_for_one-time_charges api
charges[service_period] replaces the parameter
charges[date_from] and
charges[date_to] in create_a_quote_for_one-time_charges api
consolidated_view has been added in retrieve_quote_as_pdf api
customer[business_customer_without_vat_number] has been added in create_a_subscription, update_a_subscription apis
CHECKOUT_COM has been added in Gateway enum
CONTRACT_TERMINATION has been added to eventBasedAddons onEvent enum
IDEAL,
GOOGLE_PAY has been added to Payment types enum
CONTRACT_TERM_CREATED,
CONTRACT_TERM_RENEWED,
CONTRACT_TERM_TERMINATED,
CONTRACT_TERM_COMPLETED,
CONTRACT_TERM_CANCELLED have been added
total_payable and
charge_on_acceptance has been added in Quote resource.
cancel_at has been added in cancel_a_subscription api
taxjar_product_code has been added in Addon and Plan resource.
taxjar_product_code has been added in create_an_addon, update_an_addon, create_a_plan and update_a_plan api
taxjar_exemption_category has been added in create_a_customer, update_a_customer , create_a_subscription and import_a_subscription api
no_expiry has been added in gift_subscription_estimate and create_a_gift api
no_expiry has been added in Gift resource
BUSINESS_CHECKING has been added in AccountType enum
CCD has been added in EcheckType enum
GIFT_UPDATED has been added
taxjar_exemption_category has been added
reference_id in payment_intent has been added in create_a_gift, create_an_invoice, create_using_payment_intent, create_a_subscription, create_subscription_for_customer, update_a_subscription, reactivate_a_subscription, resume_a_subscription, create_a_customer and collect_payment_for_customer api.
payment_intent has been added in create_a_gift, create_an_invoice, reactivate_a_subscription and resume_a_subscription api.
client_profile_id has been added in customer resource.
client_profile_id has been added in create_a_customer, update_a_customer, create_subscription_estimate, create_a_subscription and import_a_subscription api.
replace_primary_payment_source has been added in create_an_invoice api.
currency_code has been added in payment_intent resource.
payment_intent has been added.
id in payment_intent sub-param has been added in create_a_customer, collect_payment_for_customer, create_using_payment_intent, create_a_subscription, create_subscription_for_customer and update_a_subscription .
PAYMENT_INTENT_CREATED and
PAYMENT_INTENT_UPDATED have been added.
tax_amount_in_local_currency and
local_currency_code have been added in line_item_tax sub-resource of credit_note, credit_note_estimate, invoice, invoice_estimate, order and quote resources.
sub_total_in_local_currency,
total_in_local_currency and
local_currency_code have been added in credit_note and invoice resources.
gw_payment_method_id has been added in create_a_customer, collect_payment_for_customer, create_using_payment_intent, create_a_subscription, create_subscription_for_customer and update_a_subscription api.
name,
invoice_id and
notes have been added in quote resource.
name,
notes and
expires_at have been added in create_a_quote_for_a_new_subscription, create_a_quote_for_update_subscription and create_a_quote_for_one-time_charges api.
id,
auto_collection and
po_number have been added in convert_a_quote api.
ref_tx_id has been added in card resource.
customer_id has been added in credit_note_estimate and invoice_estimate resource.
payment_intent with
gateway_account_id and
gw_token have been added in create a customer, collect payment for customer, create subscription, create subscription for customer and update subscription API.
dunning_type has been added.
vantiv has been added in the gateway enum.
sepa_credit has been added in payment method enum.
dunning_attempts has been added in invoice resource.
reference_transaction has been added in update card payment source API.
initiator_type and
three_d_secure have been added in transaction resource.
scheme has been added in virtual_bank_account resource.
scheme has been added in create a virtual bank account using permanent token and create a virtual bank account API.
Hierarchy and
Token have been added.
day has been added in period_unit and shipping_frequency_period_unit.
fractional_correction,
comment and
date_from,
date_to in line_item have been added in Create credit note API.
customer_id has been added to line_item sub resource of 'Credit note', 'Credit note estimate', 'Invoice', 'Invoice estimate' and 'Quote'.
business_customer_without_vat_number and
relationship have been added to customer resource.
parent_id,
payment_owner_id,
invoice_owner_id have been added in 'List customers', 'Export revenue recognition reports', 'Export Deferred Revenue Reports' and 'Export customers APIs'.
token_id has been added in 'Collect payment' API.
hierarchy_created,
hierarchy_deleted,
token_created,
token_consumed and
token_expired have been added.
service_period_in_days has been added in 'Create subscription estimate', 'Create subscription for customer estimate', 'Update subscription estimate', 'Checkout new', 'Checkout existing', 'Create subscription for customer quote', 'Update subscription quote', 'Create subscription', 'Create subscription for customer', 'Update subscription', 'Import subscription' and 'Import subscription for customer'.
payment_owner has been added in 'Export revenue recognition reports', 'Export Deferred Revenue Reports', 'Export Invoice' and 'List Invoice APIs'.
payment_owner has been added to invoice.
date_from and
date_to have been added to 'Create an invoice', 'Create a invoice for add-on', 'Create a invoice for charge', 'Create a quote for one-time charges', 'Add charge at term end' and 'Add add-on at term end'.
comment has been added to 'Stop dunning', 'Apply payments', 'Apply credits', 'Add charge', 'Add add-on charge', 'Update details' and 'Close Invoice APIs'.
claim_credits has been added to 'delete invoice' API.
override_relationship has been added to subscription resource.
token_id has been added to 'Create subscription' API.
override_relationship has been added to 'Create subscription for customer' and 'Update subscription' API.
service_period_in_days has been added to event add ons sub resource.
avalara_sale_type,
avalara_transaction_type and
avalara_service_type have been added in Addon and plan resources.
avalara_sale_type,
avalara_transaction_type,
avalara_service_type have been added in 'Create Addon, 'Update Addon', 'Create Plan', 'Update Plan', 'Create Invoice', 'Create Invoice For Charge', 'Add Charge', 'Add Charge At Term End' and 'Create For Onetime Charges' api endpoints.
is_partial_tax_applied,
is_non_compliance_tax and
taxable_amount have been added in line_item_taxes of Credit Note ,Credit Note Estimate , Invoice, Invoice Estimate, Quote and Order resources.
exemption_details and
customer_type have been added in Customer resource .
exemption_details and
customer_type have been added in 'Create Customer', 'Update Customer' , 'Create Subscription Estimate', 'Create Subscription' and 'Import Subscription' api endpoints.
federal and
unincorporated have been added in tax_juris_type.
export have been added in tax_override_reason .
cancelled_at have been added in 'Cancel Order' api endpoint.
created_at,
resource_version and
updated_at have been added in Card, Payment source and Virtual Bank Account resources.
sort_by with
updated_at attribute have been added in List customer and List subscription endpoints.
updated_at and
created_at have been added in 'List Payment source' and 'List Virtual bank accounts' APIs.
quote_deleted has been added.
cybersource has been added.
subscription_id and
order_type have been added in List Order API.
quote has been added.
quote_created and
quote_updated have been added.
gift_scheduled,
gift_unclaimed,
gift_claimed,
gift_expired and
gift_cancelled have been added.
checkout_gift and
claim_gift have been added.
sku has been added in
Gift attributes.
sku has been added in
Update orders API.
cancelled has been added.
giftable has been added in
List Plans API.
gift_id has been added to
Subscription resource.
authorization_reason,
reference_authorization_id,
amount_capturable and
linked_payments have been added in
Transaction resource.
amount_capturable has been added in Export transaction API.
authorization_transaction_id and
auto_collection have been added in
Create invoice API.
authorization_transaction_id has been added in
Collect payment for invoice API.
blocking_funds and
verification has been added in
Transaction resource.
amount_capturable has been added in
List transactions API.
authorization_succeeded,
authorization_voided,
order_ready_to_process,
order_ready_to_ship have been added.
pricing_model and
tiers have been added in
Addon ,
Plan and
UnbilledCharge resources.
pricing_model,
tier_starting_unit,
tier_ending_unit and
tier_price have been added in
Create addon ,
Update addon ,
Create Plan and
Update Plan APIs.
line_item_tiers has been added in
creditNote ,
Invoice ,
InvoiceEstimate and
CreditNoteEstimate resources.
pricing_model has been added to line_tem sub-resource of
CreditNote ,
Invoice ,
InvoiceEstimate and
CreditNoteEstimate resources.
line_item_amount has been added in
Create credit note API.
line_item_unit_amount and
line_item_quantity have been changed to optional parameters in
Create Credit Note API.
line_item_id,
line_item_tier_line_item_id,
line_item_tier_starting_unit,
line_item_tier_ending_unit,
line_item_tier_quantity_used,
line_item_tier_unit_amount have been added in
Import invoice API.
amount has been added to Addon subResource attributes of
Subscription API.
plan_amount has been added to
Subscription API.
pricing_model with values flat_fee, per_unit, tiered, volume and stairstep have been added.
tiered,
volume and
stairstep have been added to the attribute charge_model of
Plan resource.
type has been deprecated in
List Addon API.
charge_model has been deprecated in
List Plan API.
is_shippable,
shipping_frequency_period and
shipping_frequency_period_unit would be added in
Plan and
Addon resource.
is_shippable,
shipping_frequency_period and
shipping_frequency_period_unit would be added in
Create plan ,
Update plan ,
Create addon and
Update addon APIs.
vat_number_validated_time,
vat_number_status and
is_location_valid would be added in
Customer resource.
order_created,
order_updated,
order_cancelled,
order_delivered and
order_returned would be added.
queued,
awaiting_shipment,
on_hold,
delivered,
shipped,
partially_delivered and
returned would be added.
subscription_affiliate_token would be added to
Checkout New Hosted Pages API.
document_number,
customer_id,
subscription_id,
cancellation_reason,
payment_status,
order_type,
price_type,
order_date,
shipping_date,
shipment_carrier,
invoice_round_off_amount,
tax,
amount_paid,
amount_adjusted,
refundable_credits_issued,
refundable_credits,
rounding_adjustement,
paid_on,
shipping_cut_off_date,
delivered_at,
shipped_at,
resource_verison,
updated_at,
cancelled_at,
order_line_items,
shipping_address,
billing_address,
discount,
sub_total,
total,
line_item_taxes,
line_item_discounts,
linked_credit_notes,
deleted and
currency_code would be added in
Order resource.
shipping_date,
order_date,
cancelled_at,
cancellation_reason,
shipped_at,
delivered_at,
shipment_carrier,
shipping_address,
order_line_item would be added in
Update order API.
include_deleted,
shipping_date,
order_date,
paid_on and
updated_at would be added in
List Orders API.
addon_applicability,
applicable_addons,
attached_addons and
event_based_addons have been added to
Plan resource.
addon_applicability,
applicable_addons,
attached_addons and
event_based_addons have been added in
Create plan and
Update plan APIs.
event_based_addons and
charged_event_based_addons have been added to
Subscription resource.
mandatory_addons_to_remove and
event_based_addons have been added in
Create subscription ,
Create subscription for customer ,
Update subscription ,
Create subscription estimate ,
Create subscription for customer estimate ,
Update subscription estimate ,
Checkout new subscription and
Checkout existing subscription APIs.
event_based_addons and
charged_event_based_addons have been added in
Import subscription and
Import subscription for customer APIs.
charges_handling has been added to
Resume a subscription and
Resume subscription estimate APIs.
pause_date and
resume_date have been added to
Import subscription and
Import subscription for customer APIs.
high_value_physical_goods has been added.
round_off_amount has been added in
Credit Note Estimate and
Invoice Estimate sub resources.
bank_account has been added in
Create a customer and
Create a subscription APIs.
account_holder_type,
account_type,
echeck_type have been added to
bank_account subscription resource in
Payment Source resource.
echeck,
account_holder_type,
last4 have been added to
bank_account subscription resource in
Payment Source resource.
bluesnap has been added.
virtual_bank_account_added,
virtual_bank_account_updated and
virtual_bank_account_deleted have been added.
ach_credit has been added.
create_current_term_invoice, transaction
amount,
payment_method,
reference_number and
date have been added to
Import a subscription and
Import subscription for customer APIs.
expected_payment_date has been added to
Invoice attributes.
subscription_pause has been added to
Credit note attributes.
subscription_paused,
subscription_pause_scheduled,
subscription_scheduled_pause_removed,
subscription_resumed,
subscription_resumption_scheduled and
subscription_scheduled_resumption_removed have been added.
deleted would be added to
Payment source resource.
disposition_type has been added to
Retrieve Invoice as PDF and
Retrieve Credit Note as PDF APIs.
balance_currency_code has been deprecated and attribute
currency_code has been added to Balances sub-resource in
Customer resource.
done_by has been added to
Promotional credits resource.
wechat_pay has been added.
settled_at has been added to the
Transaction resource.
Update invoice details has been added to the
Invoices resource.
payment_method_issuing_country has been released in
create a customer ,
update payment method for a customer ,
create a subscription ,
update a subscription API
issuing_country has been released in
create using temporary token and
create using permanent token API
subscription_changes_scheduled,
subscription_scheduled_changes_removed and
pending_invoice_updated has been released
orbital has been released
add_promotional_credits,
deduct_promotional_credits and
set_promotional_credits has been deprecated in
customer resource
promotional_credits_added and
promotional_credits_deducted has been added
Coupon Set has been added
coupon_set_id has been added to
Coupon Code resource
coupon_set_created,
coupon_set_updated,
coupon_set_deleted,
coupon_codes_added,
coupon_codes_updated,
coupon_codes_deleted
create a coupon code for a couponhas been deprecated in
coupon code resource
Collect payment for customer in
customer resource
Manage payment source and
Collect now has been added as deprecated API to
hosted page . Please mail us at
support@chargebee.com to enable
remaining_billing_cycles has been added in
addons under subscription resource.
vat_number in Hosted pages
Checkout new and
Checkout existing APIs.
gateway_meta_data type has been changed to Json in
Update a card payment source API.
Collect payment for a customer has been added to
Customer as a restricted and deprecated API. Please mail us at
support@chargebee.com to enable.
amount_to_collect has been added to
Invoice resource.
payment_source_id has been added to the
transaction resource.
payment_source_id has been added in
List transactions API.
amazon_payments and
paypal_express_checkout has been added.
registered_for_gst has been added to the
Customer resource.
registered_for_gst has been added in
Create a customer ,
Update billing info for a customer ,
Create subscription estimate ,
Update subscription estimate ,
Create a subscription and
Update a subscription APIs.
tmp_token has been deprecated in card subresource in
Create a customer ,
Create a subscription ,
Update a subscription and
Import subscription APIs.
tmp_token has been added to payment method subresource in
Create a subscription API.
apple_pay has been added to
payment method types.
credit_option_for_current_term_charges,
unbilled_charges_option,
refundable_credits_handlingand
account_receivables_handling have been added in
Cancel subscription API.
Cancel subscription estimate has been added to the
Estimate resource.
deleted has been added to the
Unbilled charge resource.
include_delted has been added to the
List unbilled charges API.
trial_end has been added to
Subscriptions Addon subresource.
trial_end has been added to Addon subresource in
Create a subscription ,
Create subcription for customer ,
Update a subcription ,
Create subscription estimate ,
Create subscription for customer estimate and
Update subscription estimate APIs.
billing_date,
billing_date_mode,
billing_day_of_week,
billing_day_of_week_mode,
unbilled_charges have been added to the
Customer resource.
billing_alignment_mode has been added to
Create a subscription ,
Create subcription for customer ,
Update a subcription ,
Reactivate subscription ,
Create subscription estimate ,
Create subscription for customer estimate ,
Update subscription estimate ,
Checkout new subscription and
Checkout existing subscription APIs.
status has been added to the
Create a plan ,
Create an addon and
Create a coupon APIs.
fraudulent has been added to the
Credit note resource.
bank_name is made optional in Bank Account subresource.
redirect_url has been made optional in
Create a portal session API.
phone has been added to the
List Customer API.
payment_source_id has been added to the
Card resource.
subscription_id has been added to the lineitems subresource in
Invoice ,
Credit Note ,
Invoice estimate ,
Next invoice estimate and
Credit Note estimate .
consolidated_invoicing,
primary_payment_source_id,
backup_payment_source_id and the subresource list
referral_urls have been added to the
Customer resource.
unbilled_charge_estimates has been added to the
Estimate resource.
auto_collection,
invoice_immediately and
consolidated_invoicing have been added to
Create subscription API.
auto_collection,
payment_source_id and
invoice_immediately have been added to
Create subscription for customer API.
credit_type and
reference have been added to
Add promotional credits for a customer ,
Deduct promotional credits for a customer and
Set promotional credits for a customer APIs.
invoice_immediately has been added to the
Update a subscription ,
Reactivate subscription ,
Create subscription estimate ,
Create subscription for customer estimate and
Update subscription estimate APIs.
auto_collection has been added to the Subscription subresource and
consolidated_invoicing has been added to the Customer subresource in
Checkout new subscription API.
payment_source_id has been added to
Import a subscription ,
Create an invoice ,
Create invoice for charge ,
Create invoice for addon and
Collect payment for an invoice APIs.
payment_source_added,
payment_source_updated and
payment_source_deleted have been added.
line_item_discounts has been added to the
Invoice ,
Credit note ,
Invoice estimates and
Credit note estimates resources.
generic,
alipay and
unionpay have been added to the Payment Method type in the
Customer resource.
updated_at,
resource_version and
checkout_info have been added to the
Hosted Page resource.
adyen has been added.
terms_to_charge has been added in
Create a subscription ,
Create subscription for a customer ,
Create subscription estimate ,
Create subscription for customer estimate ,
Reactivate a subscription and
Checkout new hosted pages APIs.
next_billing_at has been added in
List Subscriptions API.
force_term_reset has been added to
Checkout existing hosted pages API.
has_advance_charges has been added to the
Invoice resource.
id and
for_site_merging have been added to
Copy an addon ,
Copy a coupon and
Copy a plan API.
customer_moved_out and
customer_moved_in have been added.
ignore_scheduled_cancellation and
ignore_scheduled_changes have been added to the
Subscription renewal estimate API.
Subscription cancellation has been added to the
Credit note resource.
next_billing_at has been added to the
Subscription resource.
terms_to_charge,
reactivate,
reactivate_from have been added to
Update a Subscription ,
Update subscription estimate and
Checkout existing hosted page APIs.
reactivate_from has been added to
Reactivate a subscription API.
gateway_account_id has been added to Card resource. A input param
gateway has been deprecated and a new input param
gateway_account_id has been added to
Update card for customer ,
Switch gateway and
Copy card APIs.
gateway has been deprecated and a new input param
gateway_account_id has been added to Card and Payment method sub resource in
Create a customer ,
Create a subscription ,
Update a subscription and
Import subscription API.
fraud_flag has been added to
Update customer API.
gateway has been deprecated and a new input param
gateway_account_id has been added to Payment method sub resource in
Update payment method for a customer API.
gateway has been deprecated and a new input param
gateway_account_id has been added to the Card resource in
Checkout new ,
Checkout existing and
Update Payment method Hosted Page APIs.
billing_address and
shipping_address has been added to
Checkout new hosted page API.
plan_unit_price,
setup_fee,
billing_period,
billing_period_unit and
plan_free_quantity have been added to the
Subscription resource.
plan_unit_price,
setup_fee and Addon
unit_price has been added to
Create a subscription ,
Create subscription for customer ,
Update a subscription ,
Create a subscription estimate ,
Update a subscription estimate ,
Checkout a new subscription and
Checkout existing subscription ,
Import a subscription and
Import subscription for customer APIs.
unit_price has been added to Charge addon at term end,
Create an Invoice ,
Create invoice for addon and
Add addon item to pending invoice APIs.
locale has been added to the
Customer resource.
locale has been to
Create a customer ,
Update a customer ,
Checkout new hosted page ,
Create a subscription and
Import a subscription APIs.
mrr,
exchange_rate and
base_currency_code have been added to the
Subscription resource.
cancelled_at has been added to
List Subscription API.
voided_at has been added to the Invoice and the
Credit Note resource and
voided_at filter has been added to
List invoices and
List credit notes APIs.
sku,
accounting_code,
accounting_category1 and
accounting_category2 have been added to the
Plan and the
Addon resource.
sku,
accounting_code,
accounting_category1 and
accounting_category2 have been added to
Create a plan ,
Update a plan ,
Create an addon and
Update an addon APIs.
transaction_id_at_gateway,
transaction_status,
transaction_error_code and
transaction_error_text have been added to
Record an invoice payment API.
funding_type has been added to
Card resource.
tax_profile_id will be added to
Create plan ,
Update a plan ,
Create an addon , and
Update an addon APIs.
non_compliant_customer will be added. Refer to
Subscription attributes for more information.
updated_at and
resource_version have been added to
Plan ,
Addon , and
Coupon resources.
plan_created, plan_updated, plan_deleted, addon_created, addon_updated, addon_deleted, coupon_created, coupon_updated, coupon_deleted, netd_payment_due_reminder.
posted has been added. Refer to
Invoice attributes for more information.
net_term_days has been added to the
Customer resource and a new input parameter
net_term_days has been added to
Create a customer ,
Update a customer , and
Create a Subscription APIs.
preferred_currency_code has been added to the
Customer resource. A new input parameter
preferred_currency_code has been added to
Create a customer and
Update a customer APIs.
coupon has been deprecated and an alternate new parameter
coupon_ids has been added to
Create a Subscription ,
Create subscription for customer ,
Update Subscription ,
Create subscription estimate , and
Update subscription estimate APIs.
force_term_reset and
replace_coupon_list have been added to
Update a subscription and
Update subscription estimate APIs.
updated_at,
resource_version, and
deleted will be returned as part of
Customer ,
Subscription ,
Invoice ,
Credit Note , and
Transaction resources.
include_deleted has been added to
Customer ,
Subscription ,
Invoice ,
Credit Note , and
Transaction List APIs.
date has been added to
Create Credit Note API.
gocardless has been added for
Card resource.
forward_url has been added for
Create a portal session API.
validation_status has been added to
address .
validation_status has been added to billing address of
Customer resource and the attribute
fraud_flag will now be returned in Customer in case of any fraudulent transactions. The APIs
Create a Customer ,
Update Billing Info for a Customer will take in
validation_status as input parameter for address objects.
validation_status has been added to
Subscription 's shipping address. The APIs
Create a subscription ,
Create Subscription for customer , and
Update subscription will now take in
validation_status for address objects.
validation_status will be returned as part of billing and shipping address in
Invoice resource.
created_from_ip,
card_ip_address has been deprecated from
Customer and
Subscription resource.
tmp_token has been added to Payment Method subresource that can be used in
Create a customer and
Update payment method for a customer APIs for direct_debit type through Stripe gateway.
pending_verification has been added to the subresource attribute Payment Method status.
invoice_notes has been added to subscription in Hosted Pages
Checkout new and
Checkout existing APIs.
paid_at has been added to
List invoices API and the parameter
paid_on_after has been deprecated.
occurred_at,
webhook_status, and
event_type have been added to
List events and the parameters
start_time,
end_time,
webhook_status, and
event_type have been deprecated.
currency_code has been added as part of
Plans ,
Addons ,
Coupons ,
Subscription ,
Transaction , and
Estimate resources.
currency_code has been added to the
Set promotional credits for a customer ,
Add promotional credits to a customer , and
Deduct promotional credits for a customer APIs.
third_party_payment_method will be returned on performing
Copy card API.
next_invoice_estimate will be returned as part of the
Estimate resource.
currency_code will be returned as part of the
Credit Note resource.
wepay has been added for the
Card resource.
