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:

2024-10-17

New resource added: payment_schedule_estimate .
New attribute name added to the resource payment_schedule_scheme .
New attribute payment_schedule_estimates added to the resource estimate .
New attribute usage_accumulation_reset_frequency added to the resource item_price .
New attribute usage_accumulation_reset_frequency added to the resource subscription .
New attribute usage_accumulation_reset_frequency added to the resource quoted_subscription .
New input parameter usage_accumulation_reset_frequency added to the endpoint item_price.create_an_item_price .
New input parameter usage_accumulation_reset_frequency added to the endpoint item_price.update_an_item_price .
New input parameter discounts added to the endpoint create_pricing_page_for_new_subscription .
New input parameter discounts added to the endpoint create_pricing_page_for_existing_subscription .
New input parameter invoice_immediately added to the endpoint quote.convert_a_quote .

2024-09-19

New resource added: payment_schedule_schemes .
New attribute bundle_items added to the resource item .
New attribute bundle_configuration added to the resource item .
New input parameter bundle_configuration added to the endpoints create_an_item , update_an_item , and list_items .
New input parameter bundle_items_to_add added to the endpoints create_an_item and update_an_item .
New input parameter bundle_items_to_update added to the endpoint update_an_item .
New input parameter bundle_items_to_remove added to the endpoint update_an_item .
New input parameter payment_schedule added to the endpoint create_a_purchase .
New enum value added: payment_schedules_created to the enum event_type .
New enum value added: payment_schedules_updated to the enum event_type .
New enum value added: payment_schedule_scheme_created to the enum event_type .
New enum value added: payment_schedule_scheme_deleted to the enum event_type .
Resources installment, installment_config, and installment_detail have been removed.
Endpoint create_installment_for_an_invoice has been removed from the resource invoices .
Input parameter installment_info has been removed from the endpoint create_a_purchase .
Enum values: invoice_installments_created, invoice_installments_updated, installment_config_created, and installment_config_deleted have been removed from the enum event_type .

2024-08-29

New resource added: customer_entitlement .
New enum value added: customer_entitlements_updated to the enum event_type .
New enum value added: subscription_moved_in to the enum event_type .
New enum value added: subscription_moved_out to the enum event_type .
New enum value added: subscription_movement_failed to the enum event_type .

2024-08-14

New attribute feature_type added to the resource subscription_entitlement .
Attribute business_entity_id has been made optional in the quote resource.
Attribute business_entity_id has been made optional in the credit_note resource.
New input parameter invoice_usages added to the endpoint update_subscription_for_items .
New input parameter invoice_usages added to the endpoint estimate_for_updating_a_subscription .

2024-07-31

New attribute effective_from added to the resource entitlement_override .
New attribute status_transition_reason added to the resource ramp .
New attribute billing_period added to the resource subscription .
New attribute billing_period_unit added to the resource subscription .
New attribute updated_at added to the resource usage .
New enum value added: subscription_items_renewed to the enum event_types .
New enum value added: subscription_ramp_drafted to the enum event_types .
New enum value added: subscription_ramp_updated to the enum event_types .

2024-07-19

New attribute change_option added to the resource hosted_page .
New attribute changes_scheduled_at added to the resource hosted_page .

2024-07-03

New resource added: currencies.
New resource added: pricing_page_sessions.
New enum added: cancel_option.
New enum value added: online_banking_poland to the enum payment_source.type .
New enum value added: online_banking_poland to the enum payment_intent.payment_method_type .
New input parameters cancel_option added to the endpoints cancel_subscription_for_items_estimate and cancel_subscription_estimate .
New input parameters cancel_option added to the endpoints cancel_a_subscription and cancel_subscription_for_items .
New attribute tax_origin added to the resource invoice .
New attribute tax_origin added to the resource credit_note .

2024-05-28

New resource added: business_entities.
New resource added: business_entity_transfers.
New enum value added: nuvei to the enum gateway .
New attribute site_details_at_creation added to the resource credit_note .
New attribute site_details_at_creation added to the resource invoices .
New input parameters tax_providers_fields[provider_name], tax_providers_fields[field_id], and tax_providers_fields[field_value] added to the endpoints create_an_addon and update_an_addon .
New input parameters tax_providers_fields[provider_name], tax_providers_fields[field_id], and tax_providers_fields[field_value] added to the endpoints create_a_customer , update_a_customer , and move_a_customer .
New input parameters tax_providers_fields[provider_name], tax_providers_fields[field_id], and tax_providers_fields[field_value] added to the endpoints create_subscription_estimate , create_invoice_estimate , create_subscription_for_items_estimate , and create_invoice_for_items_estimate .
New input parameters tax_providers_fields[provider_name], tax_providers_fields[field_id], and tax_providers_fields[field_value] added to the endpoints create_invoice_for_items_and_one-time_charges , create_an_invoice , and create_invoice_for_a_one-time_charge .
New input parameters tax_providers_fields[provider_name], tax_providers_fields[field_id], and tax_providers_fields[field_value] added to the endpoints create_an_item_price and update_an_item_price .
New input parameters tax_providers_fields[provider_name], tax_providers_fields[field_id], and tax_providers_fields[field_value] added to the endpoints create_a_plan and update_a_plan .
New input parameters tax_providers_fields[provider_name], tax_providers_fields[field_id], and tax_providers_fields[field_value] added to the endpoints create_quote_for_one-time_charges , edit_quote_for_one-time_charges , create_a_quote_for_charge_and_charge_items , and edit_quote_for_charge_items_and_charges .
New input parameters tax_providers_fields[provider_name], tax_providers_fields[field_id], and tax_providers_fields[field_value] added to the endpoints create_unbilled_charges_for_item_subscription and create_unbilled_charges_for_a_subscription .
New input parameter line_items[entity_type] added to the endpoint create_credit_note .
New input parameter line_items[entity_id] added to the endpoint create_credit_note .

2024-04-30

New resource added: ramps.
New resource added: installments.
New enum value added: installment_config_created and installment_config_deleted to the enum event_type .
New enum value added: invoice_installments_created and invoice_installments_updated to the enum event_type .
New enum value added: ramp_created, ramp_deleted, and ramp_applied to the enum event_type .
New attribute tax_providers_fields added to the addon resource.
New attribute tax_providers_fields added to the customer resource.
New attribute tax_providers_fields added to the item_price resource.
New attribute tax_providers_fields added to the plan resource.
New attribute resource_verison added to the installment resource.
New attribute resource_verison added to the installment_configs resource.
New attribute klarna_pay_now added to the payment_source resource.
New attribute business_entity_id added to the unbilled_charge resource.
New input parameter changes_scheduled_at added to the endpoint update_subscription_estimate .
New input parameter change_option added to the endpoint update_subscription_estimate .
New input parameter changes_scheduled_at added to the endpoint estimate_for_updating_a_subscription_for_items .
New input parameter change_option added to the endpoint estimate_for_updating_a_subscription_for_items .
New input parameter price_variant_id added to the endpoint create_an_item_price .
New input parameter price_variant_id added to the endpoint update_an_item_price .
New input parameter price_variant_id added to the endpoint list_item_prices .
Attribute removed: additional_info from the resource invoices.statement_descriptor.
Input parameter removed: additional_info from the endpoint create_subscription_for_items .
Input parameter removed: additional_info from the endpoint create_a_subscription .
Input parameter removed: additional_info from the endpoint create_subscription_for_customer .
Input parameter removed: additional_info from the endpoint update_subscription .
Input parameter removed: additional_info from the endpoint update_subscription_for_items .
Input parameter removed: additional_info from the endpoint reactivate_a_subscription .

2024-04-03

New input parameter to_customer_id added to the endpoint move_a_subscription .
New input parameter copy_payment_source added to the endpoint move_a_subscription .

2024-03-20

New resource added: installment_configs.
New resource added: installment.
Attribute removed: product_id from the resource item_price.
New enum value added: klarna_pay_now to the enum customers.payment_method.type .
New enum value added: klarna_pay_now to the enum payment_source.type .
New enum value added: klarna_pay_now to the enum payment_intent.payment_method_type .
New enum value added: price_variant_created, price_variant_updated, and price_variant_deleted to the enum event_type .
Enum values removed: product and variant from the enum entity_type .
New input parameter config_id added to the endpoint create_installment_for_an_invoice .
New input parameter amount added to the endpoint create_installment_for_an_invoice .
New input parameter payment_source_id added to the endpoint create_a_purchase .
New input parameter installment_info[config_id] added to the endpoint create_a_purchase .
New input parameter installment_info[amount] added to the endpoint create_a_purchase .
New input parameter subscription_info[contract_term_billing_cycle_on_renewal] added to the endpoint create_a_purchase .
New input parameter contract_terms[index] added to the endpoint create_a_purchase .
New input parameter contract_terms[action_at_term_end] added to the endpoint create_a_purchase .
New input parameter contract_terms[cancellation_cutoff_period] added to the endpoint create_a_purchase .
New input parameter subscription_info[contract_term_billing_cycle_on_renewal] added to the endpoint estimates_for_purchase .
New input parameter contract_terms[index] added to the endpoint estimates_for_purchase .
New input parameter contract_terms[action_at_term_end] added to the endpoint estimates_for_purchase .
New input parameter contract_terms[cancellation_cutoff_period] added to the endpoint estimates_for_purchase .
Deprecated Input Parameters: product_created, product_updated, product_deleted, variant_created, variant_updated, and variant_deleted from the event.event_type endpoint.

2024-02-29

New attribute error_detail added to the payment_intents resource.
New attribute origin_user added to the events resource.
New attribute proration_type added to the quoted_subscription.subscription_items , and subscription.subscription_items resources.
New attributes network_error_message, recommendation_message, processor_error_code, and processor_error_message added to the transaction.error_detail resource.
New enum value added: tax_not_configured_external_provider to the enum invoices.line_items.tax_exempt_reason .
New input parameter billing_address added to the endpoint create_subscription_for_items_estimate .
New input parameter transactions[amount] added to the endpoint apply_payments .

2024-01-31

New input parameter layout added to the endpoint chargebee.credit_note.record_refund_for_a_credit_note .
New enum value added: item_price_entitlements_updated to the enum events.event_types .
New enum value added: item_price_entitlements_removed to the enum events.event_types .

2024-01-04

New resource added: entitlements.
New attribute active_id added to the customer , and subscription resources.
New attribute: proration_type added to the item_price resource.
New attribute custom_payment_method_id added to the transaction resource.
New attribute custom_payment_method_name added to the transaction resource.
New attribute error_detail added to the transaction resource.
New enum values added: cmr_falabella, tarjeta_naranja, nativa, cencosud, cabal, argencard, elo, hipercard, carnet, rupay, and maestro to the enum card.card_type .
New enum value added: transferred to the enum subscription.subscription_status .
New enum value added: transferred to the enum estimate.subscription_estimate_attributes.status .
New enum values added: 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 .
New enum values added: customer_business_entity_changed and subscription_business_entity_changed to the enum event.list_events.event_type .
New enum values added: dlocal to the enum payment_source.gateway .
New enum values added: 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. .
Input parameter reference_id has been made optional for the chargebee.payment_source.create_using_permanent_token endpoint.
New input parameters 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 .
New input parameter custom_payment_method_id added to the endpoint chargebee.customer.record_excess_payment_for_a_customer .
New input parameter proration_type added to the endpoint chargebee.estimate.update_subscription_for_items .
New input parameter proration_type added to the endpoint chargebee.subscription.update_for_items .
New input parameter custom_payment_method_id added to the endpoint chargebee.credit_note.record_refund_for_a_credit_note .
New input parameter: payment_initiator added to the endpoint chargebee.invoice.create_for_charge_items_and_charges .
New input parameter: proration_type added to the endpoint chargebee.subscription.update_for_items .

2023-11-30

New enum value added: swiss_reference to the enum payment_reference_number.type .
New input parameter subscription[po_number] added to the endpoint POST/api/v2/quotes/{quote-id}/edit_create_subscription_quote_for_items .
New input parameter subscription[po_number] added to the endpoint POST/api/v2/quotes/{quote-id}/edit_create_subscription_quote .

2023-10-31

New attribute statement_descriptor added to the invoice resource.
New enum value added: pay_com to the enum gateway .
New enum value added: pay_to, faster_payments, and sepa_instant_transfer to the enum payment_source.type .
New enum value added: pay_to, faster_payments, and sepa_instant_transfer to the enum payment_intent.payment_method_type .
New enum value added: pay_to, faster_payments, and sepa_instant_transfer to the enum customer.payment_method.type .
New enum value added: pay_to, faster_payments, sepa_instant_transfer, and amazon_payments to the enum payment_source.payment_intent.payment_method_type .
New attribute proration_type added to the addon resource.
New input parameter proration_type added to the endpoints - POST/api/v2/addons and POST/api/v2/addons/{addon-id} .
Input parameters discount_type has been made optional for the endpoints - POST/api/v2/coupons , GET/api/v2/coupons , and POST/api/v2/coupons/{coupon-id} .
Input parameters duration_type has been made optional for the endpoints - POST/api/v2/coupons , GET/api/v2/coupons , and POST/api/v2/coupons/{coupon-id} .

2023-09-26

New attribute venmo added to payment_source resource.
New attribute proration_type added to quoted_charge , quoted_subscription , and subscription resources.
New enum value added: ebanx to enum gateway .
New enum value added: venmo to enum customer.payment_method.type .
New enum value added: venmo to enum payment_source.type .
New enum value added: venmo to enum payment_intent.payment_method.type .
New enum value added: venmo to enum payment_intent[payment_method_type ] .
New input parameter card[additional_information] added to the POST/api/v2/payment_sources/create_card endpoint.
New input parameter customer[einvoicing_method] added to the POST/api/v2/hosted_pages/checkout_new_for_items endpoint.
New input parameter customer[einvoicing_method] added to the POST/api/v2/hosted_pages/checkout_one_time_for_items endpoint.

2023-09-05

New enum direct_debit_scheme added to payment_source resource.
New input parameter avalara_tax_code added to the POST/api/v2/invoices/create_for_charge_items_and_charges endpoint.
New input parameter hsn_code added to the POST/api/v2/invoices/create_for_charge_items_and_charges endpoint.
New input parameter taxjar_product_code added to the POST/api/v2/invoices/create_for_charge_items_and_charges endpoint.

2023-07-28

New attribute tax_category added to invoice , credit_note , and quote resources.
New enum value tax added to the enum invoice.notes.entity_type .
New enum value payment_source_locally_deleted added to the enum event.event_type .
New input parameter cancel_reason_code added to the POST/api/v2/customers/{customer_id}/import_for_items endpoint.

2023-06-30

New resource added: payment_reference_numbers.
New attributes added: local_currency_exchange_rate to the resources invoices and credit_notes.
New enum value added: view_voucher to enum type .
New enum value added: paused to enum store_status .
New enum values added: metrics_global and windcave to enum gateway .
Input parameter added: payment_initiator to endpoint: Collect payment for customer .
Input parameter added: payment_initiator to endpoint: Collect payment for an invoice .
Input parameter added: payment_initiator to endpoint: Create an invoice .
Input parameter added: payment_initiator to endpoint: Create invoice for a one-time charge .
Input parameter added: payment_initiator to endpoint: Create invoice for a non-recurring addon .
Input parameter added: payment_initiator to endpoint: Collect subscription for items .
Input parameter added: payment_initiator to endpoint: Update subscription for items .
Input parameter added: payment_initiator to endpoint: Reactivate a subscription .
Input parameter added: payment_initiator to endpoint: Resume a subscription .
Input parameter added: payment_initiator to endpoint: Create subscription for customer .
Input parameter added: payment_initiator to endpoint: Create a subscription .
Input parameter added: payment_reference_numbers[id] to endpoint: Import invoice .
Input parameter added: payment_reference_numbers[type] to endpoint: Import invoice .
Input parameter added: payment_reference_numbers[number] to endpoint: Import invoice .

2023-05-31


New endpoint added: POST/api/v2/hosted_pages/events .
New resource added: payment_vouchers.
New attributes added: boleto and billing_address to the resource payment_source.
New attribute added: product_id to the resource item_price.
New enum added: voucher_type.
New enum added: payment_voucher_type.
New enum added: event_name.
New enum value added: product_created to enum event_type .
New enum value added: product_updated to enum event_type .
New enum value added: product_deleted to enum event_type .
New enum value added: variant_created to enum event_type .
New enum value added: variant_updated to enum event_type .
New enum value added: variant_deleted to enum event_type .
New enum value added: voucher_created to enum event_type .
New enum value added: voucher_expired to enum event_type .
New enum value added: voucher_create_failed to enum event_type .
New enum value added: boleto to enums payment_method_type and offline_payment_method .

2023-05-16


New feature added: 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.
New feature added: 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.
Going forward, all response headers can be accessed via SDKs.

2023-04-28

New attribute added: total_contract_value_before_tax in resource contract_term.
New attribute added: subscription_contract_term_total_contract_value_before_tax in resource subscription.
New attribute added: estimate_contract_term_total_contract_value_before_tax in resource estimate.
New attribute added: coupon_item_constraints_constraint in resource coupon.
Input parameter added: contract_term[total_amount_raised_before_tax] to endpoint: Import subscription for Items .
Input parameter added: contract_term[total_amount_raised_before_tax] to endpoint: Import a subscription .
Input parameter added: contract_term[total_amount_raised_before_tax] to endpoint: Import contract term .
Input parameter added: contract_term[total_amount_raised_before_tax] to endpoint: Import subscription for customer .
Input parameter added: contract_term[total_contract_value_before_tax] to endpoint: Import contract term .
Input parameters added: coupon_constraints[entity_type], coupon_constraints[type], and coupon_constraints[value] to endpoint: Create a coupon for items .
Input parameters added: coupon_constraints[entity_type], coupon_constraints[type], and coupon_constraints[value] to endpoint: Update a coupon for items .
Input parameter added: export_type to endpoint: Export Customers .
Input parameter added: export_type to endpoint: Export Subscription .
New enum value added: pending_authorization to enum status .
New enum added: export_type.

2023-03-24


New attribute added: credit_note_einvoice_reference_number in resource credit_note.
New attribute added: invoice_einvoice_reference_number in resource credit_note.
New attribute added: customer_einvoicing_method in resource customer.
New attributes added: in_app_subscription_store_status and in_app_subscription_invoice_id in resource in_app_subscriptions.

Input parameter added: einvoicing_method to endpoints: Update billing info for a customer and Create a customer.
Input parameter added: einvoicing_method to endpoints: Update subscription for items , Update a subscription , and Create a subscription .
Input parameter added: subscription_info[meta_data] to endpoint: Create a purchase .

2023-02-17

New attribute added: is_advance_charge in resource unbilled_charge.
Input parameter added: updated_at to endpoint: List attached items .
Input parameter added: attached_item[updated_at] to endpoint: Export Attached Items .
Input parameter added: coupon_ids[0..n] to endpoint: Checkout Gift subscription for Items .
Input parameter added: customer[email], customer[first_name], and customer[last_name] to endpoint: Process Purchase Command .
New enum value added: ecentric to enum gateway .
Input parameter removed: EstimateRequest#invoice_info[po_number] and EstimateRequest#invoice_info[notes] from purchase resource.
Deprecated input parameter CheckoutGiftRequest#subscription[coupon] in resource hosted_page.

2023-01-13

New attributes added: shipping_address and billing_address in resource credit_note.
New attribute added: is_advance_charge in resource unbilled_charge.
Input parameter added: subscription[po_number] to endpoint: create_a_quote_for_a_new_subscription_items .
Input parameter added: unbilled_charges[is_advance_charge] to endpoint: import_unbilled_charges .
Input parameter added: has_advance_charges to endpoint: import_invoice .
New enum value added: subscription_trial_extended to enum event_type .
New enum value added: zero_value_item to enum tax_exempt_reason .
New enum value added: bank_of_america to enum gateway .

2022-11-21

Input parameter added: skip_billing_cycles to endpoint: pause_a_subscription .
Input parameter added: subscription[skip_billing_cycles] to endpoint: pause_subscription_estimate .
Input parameters added: is_written_off, write_off_amount, write_off_date, and credit_note[id] to endpoint: import invoices .
New enum value added: skip_billing_cycles to enum pause_option .

2022-10-11

New attribute added: shipped_at in resource order.
New attribute added: business_entity_id in resource order.
Input parameter added: void_reason_code and voided_at to endpoint: import invoices .
New enum value added: type to enum subscription_discounts_type .
New enum value added: subscription_entitlements_created to enum event_type .
New enum value added: registered to enums credit_note_einvoice_status and invoice_einvoice_status .

2022-09-20

New endpoint added: POST/api/v2/subscriptions .
New attribute added: billing_month in resource customer.
Input parameter added: billing_month to endpoint: change_billing_date .
Input parameter added: line_items[subscription_id] to endpoints: change_billing_date .
New enum value added: global_payments to enum payment_source_gateway .
New enum values added: apply_on, operation_type, duration_type, and layout.

2022-08-22

New attribute added: resource_version in resource token.
New attribute added: updated_at in resources unbilled_charge and token.
New attribute added: 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.
New attribute added: 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 .
New attribute added: payment_method_details in resource transaction.
New resource added: in_app_subscriptions.
Input parameters removed: business_entity_id from endpoints: create_a_purchase and estimates_for_purchase .

2022-07-18

New attribute added: business_entity_id in resources credit_note, customer, hosted_page, payment_intent, quote, subscription, and transaction.
New attribute added: discount.coupon_set_code in resources credit_note, credit_note, credit_note_estimate, invoice, invoice_estimate, quote_line_group, and quote.
New attribute added: Subscription Estimate Attributes in resource subscription_estimate.
New resource added: purchase.
New resource added: impacted_subscription.
New resource added: impacted_items.
New enum value added: chargebee_payments to enum payment_source_gateway .
New enum value added: bancontact and not_applicable to enum #payment_source_card_brand .
New enum value added: business_entity_created, business_entity_updated, and business_entity_deleted to enum event_types .
New enum value added: business_entity to enum entity_type .
New enum value added: direct_debit to enum payment_method_type .

2022-05-23

New resource added: feature.
New resource added: subscription_entitlement.
New resource added: item_entitlement.
New resource added: entitlement_override.
New endpoint added: GET/api/v2/features .
New endpoint added: POST/api/v2/features .
New filter parameter added: einvoice[status] to endpoint list_credit_notes .
New enum value added: paypal_express_checkout to enum payment_source.type .
New enum value added: current to enum payment_source.bank_account.account_type .
New enum value added: 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 .

2022-04-25

New attribute added: channel in resources: addon, attached_item, credit_note, customer, invoice, item_family, item_price, plan, and subscription.
New attribute added: channel in resource item.
New attribute added: external_name in resource item.
New input parameter added: external_name to endpoints: create-an-item and update-an-item .
New input parameter added: channel to endpoint: list_credit_notes .
New input parameter added: channel to endpoint: list_customers .
New input parameter added: channel to endpoint: list_addons .
New input parameter added: channel to endpoint: list_items .
New input parameter added: channel to endpoint: list_invoices .
New input parameter added: channel to endpoint: list_item_prices .
New input parameter added: channel to endpoint: list_plans .
New input parameter added: channel to endpoint: list_subscriptions .
New input parameter added: credit_note[channel] to endpoint: export_credit_notes .
New input parameter added: customer[channel] to endpoint: export_customers .
New input parameter added: addon[channel] to endpoint: export_addons .
New input parameter added: item[channel] to endpoint: export_items .
New input parameter added: invoice[channel] to endpoint: export_invoices .
New input parameter added: item_price[channel] to endpoint: export_item_prices .
New input parameter added: plan[channel] to endpoint: export_plans .
New input parameter added: subscription[channel] to endpoint: export_subscriptions .
New input parameters added: invoice[channel], subscription[channel], and customer[channel] to endpoints: export_revenue_recognition_reports and export_deferred_revenue_reports .
Existing input parameter updated: item_family_id in endpoint: create_an_item has been made a 'required' parameter.
Existing enum value removed: coupon_expired from enum: event_type.

2022-03-14

New input parameter added: net_term_days to endpoints: create_subscription_for_items , update_subscription_for_items , and import_subscription_for_items .

2022-03-08

New attribute added: coupon in resource hosted_pages.
New attributes added: upi, mandates, and it's sub-attributes to resource payment_sources.
New input parameters added: 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 .
New input parameter added: subscription_id to endpoints: list_payment_sources .
New input parameter added: activated_at to endpoints: import_subscription_for_items , import_a_subscription , and import_subscription_for_customer .
New enum values added: upi and netbanking_emandates to enum payment_method[type] of resource customer.
New enum value added: current to enum bank_account[account_type].
New enum values added: quickbooks and razorpay to enum gateway.
New enum values added: upi and netbanking_emandates to enum payment_method, payment_method_type, and type.
New enum values added: upi, netbanking_emandates and apple_pay to enum payment_method_type of resource payment_intents.
New enum value added: current to enum bank_account_type of resource payment_sources.
Deprecated enum NetdPaymentDueReminder in parameter event_type.

2022-01-21

New attributes added: is_einvoice_enabled, entity_identifier_scheme, entity_identifier_standard, and entity_identifiers to the resources customer.
New attributes added: einvoiceto the resources invoice.
New attributes added: einvoiceto the resources credit_notes.
New attributes added: mime_typeto the resources downloads.
New attribute added: einvoice.status to resource credit_note.
New attributes added: 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.
New input parameters added: 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 .
New input parameter added: entity_identifiers[operation] to endpoint: update_billing_info_for_a_customer apis .
New input parameters added: 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 .
New input parameters added: customer[entity_identifier_scheme], customer[entity_identifier_standard], customer[is_einvoice_enabled], to endpoint: update_a_subscription and update_subscription_for_items api.
Input parameter marked mandatory: hierarchy_operation_type for the endpoint get_hierarchy .
Unused input filter parameter removed: create_pending_invoices from endpoint list_subscriptions .

2021-12-08

New resource added: tax_withheld.
New attribute added: hsn_code to the resources addon, item_price and plan.
New attributes added: first_name, last_name and email to the resource payment_sources.
New query parameters added: 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 .
New query parameter added: tax_detail[hsn_code] to endpoints: POST/api/v2/item_prices and POST/api/v2/item_prices/{item_price_id} endpoints.
New query parameter added: include_deleted to endpoints: GET/api/v2/plans and GET/api/v2/addons .
New enum values added: subscription_activated_with_backdating, tax_withheld_recorded, tax_withheld_deleted, and tax_withheld_refunded to enum event_type.

2021-10-14

New attribute added: entity_id to resource order_line_item_discounts.
New input parameters added: 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 .
New input parameter added: replace_primary_payment_source to endpoints POST/api/v2/customers/{customer_id}/subscriptions and POST/api/v2/customers/{customer_id}/subscription_for_items .
New enum value added: coupon_expired to enum event_type.
New enum value added: mollie to enum gateway.
New enum value added: item_level_discount and document_level_discount to enum discount_type.

2021-08-16

New resource added: quoted_charge.
New attribute added: generated_at to resources credit_note and invoice.
New attribute added: change_option to resource quoted_subscription.
New attribute added: changes_scheduled_at to resources subscription and quoted_subscription.
New attributes added: iin and last4 to resource transaction.
New query parameters added: invoice_date, create_pending_invoices, and first_invoice_pending to endpoint POST/api/v2/quotes/{quote_id}/convert .
New query parameter added: subscription[auto_close_invoices] to endpoint POST/api/v2/quotes/{quote_id}/convert .
New enum value added: subscription_cancel to enum charge_event in resource quote_line_groups.
New enum values added: 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
Deprecated query parameter: coupon in endpoints invoices#create_invoice_for_a_one-time_charge and invoices#create_invoice_for_a_non-recurring_addon.

2021-07-22

New endpoints added: checkout_one_time_for_items and checkout_gift_for_items for resource hosted_pages.
New endpoint added: resend_an_order for resource orders.
New attributes added: accounting_category3 and accounting_category4 for resources addon, item_price and plan.
New attribute added: quantity_in_decimal to resource attached_item.
New attributes added: period and period_unit to resource coupon.
New attribute added: line_item_discounts.entity_id to resources credit_note, credit_note_estimate, invoice, invoice_estimate, quote and quote_line_group.
New attribute added: vat_number_prefix to resources credit_note, customer, invoice and quote.
New attribute added: price_in_decimal to resources differential_price and item_price.
New attribute added: exchange_rate and new_sales_amount to resources invoice.
New attribute added: archived_at to resources item and item_price.
New attribute added: trial_end_action to resources item_price, plan, subscription, and subscription_estimate.
New attributes added: resent_orders, tracking_url, resent_status, is_resent, original_order_id, and resend_reasons to resource order.
New attribute added: line_item_tiers to resource quote.
New attributes added: plan_quantity_in_decimal, and plan_unit_price_in_decimal to resources quoted_subscription and subscription.
New attributes added: contract_term_billing_cycle_on_renewal and quoted_contract_term to resource quoted_subscription.
New attributes added: 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.
New attribute added: cancel_schedule_created_at to resource subscription.
New attributes added: exchange_rate and merchant_reference_id to resource transaction.
New query parameters added: accounting_category3 and accounting_category4 to endpoints create_an_addon , update_an_addon , create_a_plan , and update_a_plan .
New query parameter added: quantity_in_decimal to endpoints create_an_attached_item , update_an_attached_item , and create_a_gift_subscription_for_items .
New query parameters added: period and period_unit to endpoints create_a_coupon , update_a_coupon , create_a_coupon_for_items , and update_a_coupon_for_items .
New query parameter added: price_in_decimal to endpoints create_a_differential_price , and update_a_differential_price endpoints.
New query parameters added: 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.
New query parameters added: 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 .
New query parameters added: 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.
New query parameters added: 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 .
New query parameters added: 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 .
New query parameter added: 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 .
New query parameter added: invoice_note to endpoint hosted_pages#checkout_one-time_payments.
New query parameters added: allow_offline_payment_methods to endpoints create_checkout_for_a_new_subscription and create_checkout_to_update_a_subscription .
New query parameters added: free_quantity_in_decimal, price_in_decimal, and trial_end_action to endpoints in create_an_item_price and update_an_item_price .
New query parameter added: tracking_url to endpoints create_an_order , update_an_order , and import_an_order .
New query parameter added: additional_information to endpoints create_using_gateway_temporary_token and create_using_permanent_token .
New filter parameters added: resent_status, is_resent, and original_order_id to endpoints exports#orders and list_orders .
New filter parameter added: updated_at to endpoints item_families and list_item_families .
New sort parameters added: name, id, and updated_at to endpoints list_items and list_item_prices .
New sort parameters added: created_at and updated_at to endpoint list_payment_sources .
New sort parameter added: usage_date to endpoint list_usage .
Deprecated parameter duration_month in resource coupon.
New enum value added: bancontact to enum card_type.
New enum values added: card and latam_local_card to enum powered_by.
New enum values added: 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.
New enum values added: item_level_discount and document_level_discount to enum discount_type.
New enum values added: add_usages_reminder and order_resent have been added to event_type enum.
New enum values added: ingenico_direct and exact have been added to gateway enum.
New enum value added: max_usage has been added to usage_calculation enum.
New enum value added: order_resent to enum cancellation_reason.
New enum value added: 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.

2021-06-30

New attribute added: merchant_reference_id to resource transactions.

2021-01-19

New resource usages is added.
New end points checkout_one-time_payments has been added in hosted_pages resource.
New attribute auto_close_invoices has been added in customers and subscriptionsresource.
New attributes metered and usage_calculation has been added to itemsresource.
New attributes create_pending_invoices and auto_close_invoices has been added to subscriptionsresource.
New parameter auto_close_invoices has been added to the endpoint create_a_customer , list_customers , update_a_customer .
New parameter invoice_allocations[invoice_id] has been added to the endpoint collect_payment_for_customer .
New parameter coupon_ids has been added to the endpoint create_invoice_for_items_estimate
New parameter subscription[auto_close_invoices] has been added to the endpoint export_revenue_recognition_reports , export_deferred_revenue_reports and export_subscriptions
New parameter customer[auto_close_invoices] has been added to the endpoint export_revenue_recognition_reports and export_deferred_revenue_reports and export_customers
New parameter customer[auto_close_invoices] has been added to the endpoint export_items .
New parameter 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 .
New parameter subscription_id has been added to the endpoint add_a_charge-item_to_a_pending_invoice .
New parameters metered and usage_calculation have been added to the endpoint create_an_item and list_item .
New parameters 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 .
New parameters create_pending_invoices and auto_close_invoices have been added to the endpoint list_subscriptions .

2020-12-15

New endpoint regenerate_invoice_estimate has been added to estimate resource
New endpoint create_a_gift_subscription_for_items has been added to gifts resource.
New endpoint regenerate_an_invoice has been added to subscriptions resource.
New attributes show_description_in_invoices, show_description_in_quotes have been added to the resource.
New attributes tiers[starting_unit_in_decimal], tiers[ending_unit_in_decimal], tiers[price_in_decimal] have been added to the resource differential_prices.
New attributes show_description_in_invoices, show_description_in_quotes have been added to the resource item_prices.
New parameters 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 .
New parameters cancel_at, contract_term_cancel_option, cancel_reason_code have been added to the endpoint cancel_subscription_for_items_estimate .
New parameters event_based_addons has been added to the endpoint cancel_subscription_for_items_estimate .
New parameters redirect_url has been added to the endpoint accept_a_quote .
New parameters token_id, retain_payment_source, card,, payment_method added have been added to the endpoint create_an_invoice .
New parameters token_id, retain_payment_source, card,, payment_method have been added to the endpoint create_invoice_for_items_and_one-time_charges .
New parameters show_description_in_invoices, show_description_in_quotes have been added to the endpoints create_an_item_price , update_an_item_price .

2020-11-16

New attributes price_in_decimal, tiers[starting_unit_in_decimal], tiers[ending_unit_in_decimal], tiers[price_in_decimal] have been added to the resource addon.
New input parameters 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 .
New attributes 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.
New input parameters line_items[unit_amount_in_decimal], line_items[quantity_in_decimal] have been added to create_credit_note api.
New input parameters 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.
New input parameters subscription[plan_quantity_in_decimal], addons[quantity_in_decimal] have been added to gift_subscription_estimate , create_a_gift , checkout_gift_subscription apis.
New input parameters 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.
New input parameter amount_in_decimal has been added to create_invoice_for_a_one-time_charge api.
New input parameter amount has been made optional to create_invoice_for_a_one-time_charge api.
New input parameters addon_quantity_in_decimal, addon_unit_price_in_decimal have been added to create_invoice_for_a_non-recurring_addon .
New input parameters 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.
Input parameters 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.
New input parameters addon_quantity_in_decimal, addon_unit_price_in_decimal have been added to add_non-recurring_addon_to_a_pending_invoice api.
New input parameter invoice_date has been added to close_a_pending_invoice api.
New attributes 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.
New attributes 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.
New attribute amount_in_decimal has been added to the resource promotional_credit.
New input parameter amount_in_decimal has been added to add_promotional_credits , deduct_promotional_credits , set_promotional_credits apis.
Input parameter amount has been made optional in add_promotional_credits , deduct_promotional_credits , set_promotional_credits apis.
New attributes unit_amount_in_decimal, quantity_in_decimal, amount_in_decimal have been added to the resource quote
New attributes 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
New attributes unit_amount_in_decimal, quantity_in_decimal, amount_in_decimal have been added to the sub resource quoted_line_group
New attributes 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
New input parameters 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.
New input parameter amount_in_decimal has been added to add_charge_at_term_end apis.
Input parameter amount has been made optional in add_charge_at_term_end apis.
New input parameters addon_quantity_in_decimal, addon_unit_price_in_decimal have been added to charge_addon_at_term_end api
New attributes 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.
New endpoint refund_a_payment has been added to the resource transaction

2020-10-16

New attribute quoted_subscriptions has been added to the resource quote.
New attributes resource_version and updated_at are added to the resource payment_intent.

2020-09-29

New attribute included_in_mrr has been added in addon and coupon resource
New attribute offline_payment_method has been added in subscription and customer resource
New input parameter included_in_mrr has been added in create_an_addon , update_an_addon , create_a_coupon and update_a_coupon apis.
New input parameter auto_collection has been added in update_a_subscription
New input parameter subscription[auto_collection] has been added in checkout_existing_subscription and update_subscription_estimate apis
New input parameter customer[offline_payment_method] has been added in export_revenue_recognition_reports , export_deferred_revenue_reports , export_customers and create_a_subscription

2020-09-09

New input parameter currency_code is added in list_addons , list_coupons , list_plans , export_plans , export_addons , export_coupons apis
New attributes powered_by has been added in card resource
New input parameters subscription[free_period], subscription[free_period_unit] have been added in create_subscription_estimate , create_subscription_for_a_customer_estimate , update_subscription_estimate apis
Input parameter invoice[customer_id] is made optional in create_invoice_estimate api
Input parameter customer_id is made optional in create_an_invoice api
Attribute created_at in dunning_attempts sub resource is made optional in the invoice resource
New attributes free_period and free_period_unit have been added in the Subscription resource
New enum type free_period_unit has been added with the values: DAY, WEEK, MONTH, YEAR
New enum type powered_by has been added in card resource with the values: IDEAL, SOFORT, BANCONTACT, GIROPAY, NOT_APPLICABLE
New endpoint import_historical_contract_terms has been added to the subscription resource
Attributes status, amount and date in the linked_payment sub resource are made optional in the transaction resource
New endpoint delete_a_virtual_bank_account has been added to the virtual_bank_account resource
New values GIROPAY and DOTPAY have been added to the payment_method_types enum
New values PAYMENT_SOURCE_EXPIRING and PAYMENT_SOURCE_EXPIRED have been added to the event_type enums
New value PAYPAL has been added to the gateway enum

2020-07-15

New attributes show_description_in_invoices, show_description_in_quotes have been added in Addon, Plan resource
New input parameters 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
New attribute create_reason_code has been added in Credit notes resource
Attribute reason_code is made optional in the Credit notes resource
New filter parameter create_reason_code is added in list_credit_notes api
New input parameter refund_reason_code has been added in Credit notes' Refund, Record a refund apis
Sub-resources parent_account_access and child_account_access have been added in Customer resource
New attribute use_default_hierarchy_settings has been added in Customer resource
New endpoint update_hierarchy_access_settings_for_a_customer has been added in Customer resource
New input parameters use_default_hierarchy_settings, parent_account_access, child_account_access have been added in link_a_customer api
New input parameter 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
New input parameter coupon_ids has been added to checkout_new_subscription , checkout_existing_subscription apis
Input parameter subscription_coupon has been deprecated in checkout_new_subscription , checkout_existing_subscription apis
New attribute void_reason_code has been added to the Invoice resource
Attribute cn_reason_code has been made optional in applied_credits, adjustment_credit_notes, issued_credit_notes, linked_credit_note sub-resources
New attribute cn_create_reason_code has been added in applied_credits, adjustment_credit_notes, issued_credit_notes, linked_credit_note sub-resources
New input parameter 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
Input parameter coupon is deprecated from create_an_invoice api
New filter parameter void_reason_code has been added to list_invoices api
New input parameter invoice_note, remove_general_note, notes_to_remove[code], notes_to_remove[code] have been added to close_a_pending_invoice api
New input parameter void_reason_code has been added to void_an_invoice api
New input parameter credit_note[code] has been added to refund_an_invoice , record_refund_for_an_invoice api
New endpoints import_an_order and delete_an_imported_order have been added to Order resource
New filter parameter exclude_deleted_credit_notes has been added to list_orders api
New attribute payment_method_type has been added to payment_intent resource and active_payment_attempt sub-resource
New input parameter payment_method_type has been added to create_a_payment_intent , update_a_payment_intent api
New attributes version, contract_term_start, contract_term_end, contract_term_termination_fee have been added to Quotes resource
New input parameters 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
New attribute version has been added to quote_line_group sub-resource
New attribute cancel_reason_code has been added to Subscriptions resource
New filter parameter cancel_reason_code has been added to list_subscriptions , cancel_a_subscription apis
New input parameter contract_term_billing_cycle_on_renewal has been added to import_a_subscription , import_subscription_for_customer apis
New input parameter event_based_addon has been added to cancel_a_subscription api
New filter parameter is_voided has been added to list_unbilled_charges api
New event_types MRR_UPDATED, ORDER_DELETED have been added
New values SOFORT, BANCONTACT have been added to the payment_method_types enum
New attributes entity_type_description has been added to the line_items sub-resource

2020-04-03

A subresource contract_term has been added in Subscription resource.
New endpoint refund_a_credit_note has been added in Credit Notes resource
New endpoint list_quote_line_groups has been added in Quotes resource
New endpoint list_contract_terms_for_a_subscription has been added in Subscriptions resource
New input parameters 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
New input parameter contract_term_cancel_option has been added in cancel_a_subscription api
New input parameter 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
New input parameter business_customer_without_vat_number has been added in create_a_customer and update_billing_info_for_a_customer apis
New input parameter addons[service_period] replaces the parameter addons[date_from] and addons[date_to] in create_a_quote_for_one-time_charges api
New input parameter charges[service_period] replaces the parameter charges[date_from] and charges[date_to] in create_a_quote_for_one-time_charges api
New input parameter consolidated_view has been added in retrieve_quote_as_pdf api
New input parameter customer[business_customer_without_vat_number] has been added in create_a_subscription, update_a_subscription apis
New value CHECKOUT_COM has been added in Gateway enum
New value CONTRACT_TERMINATION has been added to eventBasedAddons onEvent enum
New values IDEAL, GOOGLE_PAY has been added to Payment types enum
New event types CONTRACT_TERM_CREATED, CONTRACT_TERM_RENEWED, CONTRACT_TERM_TERMINATED, CONTRACT_TERM_COMPLETED, CONTRACT_TERM_CANCELLED have been added

2020-02-06

New attribute total_payable and charge_on_acceptance has been added in Quote resource.
New input parameter cancel_at has been added in cancel_a_subscription api

2020-01-08

New attribute taxjar_product_code has been added in Addon and Plan resource.
New input parameter taxjar_product_code has been added in create_an_addon, update_an_addon, create_a_plan and update_a_plan api
New input parameter taxjar_exemption_category has been added in create_a_customer, update_a_customer , create_a_subscription and import_a_subscription api
New input parameter no_expiry has been added in gift_subscription_estimate and create_a_gift api
New attribute no_expiry has been added in Gift resource
New endpoint update_a_gift has been added in Gift resource
New value BUSINESS_CHECKING has been added in AccountType enum
New value CCD has been added in EcheckType enum
New event type GIFT_UPDATED has been added
New enum taxjar_exemption_category has been added

2019-09-13

New endpoints gift_subscription_estimate and create_invoice_estimate have been added in estimate resource.
New input parameter 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.
New endpoint record_refund_for_a_payment has been added in transaction resource.

2019-08-27

New input parameter payment_intent has been added in create_a_gift, create_an_invoice, reactivate_a_subscription and resume_a_subscription api.
New attribute client_profile_id has been added in customer resource.
New input parameter client_profile_id has been added in create_a_customer, update_a_customer, create_subscription_estimate, create_a_subscription and import_a_subscription api.
New input parameter replace_primary_payment_source has been added in create_an_invoice api.
New attribute currency_code has been added in payment_intent resource.

2019-08-14

New resource payment_intent has been added.
New input parameter 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 .
New event_types PAYMENT_INTENT_CREATED and PAYMENT_INTENT_UPDATED have been added.

2019-08-07

New attributes 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.
New attributes sub_total_in_local_currency, total_in_local_currency and local_currency_code have been added in credit_note and invoice resources.
New input parameter 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.
New attributes name, invoice_id and notes have been added in quote resource.
New input parameters 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.
New input parameters id, auto_collection and po_number have been added in convert_a_quote api.

2019-07-22

The attribute ref_tx_id has been added in card resource.
The attribute customer_id has been added in credit_note_estimate and invoice_estimate resource.
The input parameters 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.
New enum dunning_type has been added.
New value vantiv has been added in the gateway enum.
New value sepa_credit has been added in payment method enum.
The attribute dunning_attempts has been added in invoice resource.
New enpoint create using payment intent has been added in payment_source resouce.
The input parameter reference_transaction has been added in update card payment source API.
New endpoint list quote has been added in quotes resource.
The attributes initiator_type and three_d_secure have been added in transaction resource.
New attribute scheme has been added in virtual_bank_account resource.
New input parameter scheme has been added in create a virtual bank account using permanent token and create a virtual bank account API.

2019-07-08

The new resources Hierarchy and Token have been added.
Value day has been added in period_unit and shipping_frequency_period_unit.
The parameters fractional_correction, comment and date_from, date_to in line_item have been added in Create credit note API.
The attribute customer_id has been added to line_item sub resource of 'Credit note', 'Credit note estimate', 'Invoice', 'Invoice estimate' and 'Quote'.
The attributes business_customer_without_vat_number and relationship have been added to customer resource.
The filter parameters 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'.
The parameter token_id has been added in 'Collect payment' API.
Event types hierarchy_created, hierarchy_deleted, token_created, token_consumed and token_expired have been added.
The parameter 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'.
The filter parameter payment_owner has been added in 'Export revenue recognition reports', 'Export Deferred Revenue Reports', 'Export Invoice' and 'List Invoice APIs'.
The attribute payment_owner has been added to invoice.
The attributes 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'.
The parameter comment has been added to 'Stop dunning', 'Apply payments', 'Apply credits', 'Add charge', 'Add add-on charge', 'Update details' and 'Close Invoice APIs'.
The parameter claim_credits has been added to 'delete invoice' API.
The attribute override_relationship has been added to subscription resource.
The parameter token_id has been added to 'Create subscription' API.
The parameter override_relationship has been added to 'Create subscription for customer' and 'Update subscription' API.
The attribute service_period_in_days has been added to event add ons sub resource.

2019-04-11

The attributes avalara_sale_type, avalara_transaction_type and avalara_service_type have been added in Addon and plan resources.
The input parameters 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.
The attributes 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.
The attributes exemption_details and customer_type have been added in Customer resource .
The input parameters exemption_details and customer_type have been added in 'Create Customer', 'Update Customer' , 'Create Subscription Estimate', 'Create Subscription' and 'Import Subscription' api endpoints.
The enum values federal and unincorporated have been added in tax_juris_type.
The enum value export have been added in tax_override_reason .
The input parameter cancelled_at have been added in 'Cancel Order' api endpoint.
New endpoint Local delete a virtual bank has been added in Virtual Bank Account resource.
New endpoint Local delete a payment source has been added in Payment Source resource.

2019-03-07

The attributes created_at, resource_version and updated_at have been added in Card, Payment source and Virtual Bank Account resources.
The input filter parameter sort_by with updated_at attribute have been added in List customer and List subscription endpoints.
New endpoint 'Export orders' has been added in Export resource.
New endpoint 'Accept quote' has been added in Hosted pages resource.
The input filter parameters updated_at and created_at have been added in 'List Payment source' and 'List Virtual bank accounts' APIs.
New endpoint 'Delete an offline transaction' has been added in Transaction resource.

2019-01-10

New event type quote_deleted has been added.
New gateway type cybersource has been added.
New filter parameters subscription_id and order_type have been added in List Order API.

2018-11-09

Entity type quote has been added.
Event types quote_created and quote_updated have been added.

2018-11-02

New resource 'Gift' with endpoints Create a gift , Retrieve a gift , Claim a gift , Cancel a gift and List gifts has been added.
New event types gift_scheduled, gift_unclaimed, gift_claimed, gift_expired and gift_cancelled have been added.
New endpoints Checkout gift and Claim gift have been added to Hosted page resource.
Input param redirect_url has been added in Manage payment sources and Collect now APIs.
Hosted page types checkout_gift and claim_gift have been added.
The attributes term_finalized and is_gifted have been added in Invoice attributes.
The attributes is_gifted, gift_note and gift_id have been added in Orders attributes.
The attribute sku has been added in Gift attributes.
The input parameter sku has been added in Update orders API.
The order status cancelled has been added.
The attributes giftable and claim_url have been added in Plan resource.
The input parameters giftable and claim_url have been added in Create a plan API.
List filter parameter giftable has been added in List Plans API.
The attribute gift_id has been added to Subscription resource.

2018-10-26

The attributes authorization_reason, reference_authorization_id, amount_capturable and linked_payments have been added in Transaction resource.
The input parameter transaction amount_capturable has been added in Export transaction API.
The input parameters authorization_transaction_id and auto_collection have been added in Create invoice API.
The input parameter authorization_transaction_id has been added in Collect payment for invoice API.
Type authorization_reason with values blocking_funds and verification has been added in Transaction resource.
New endpoints Create an authorization payment and Void an authorization transaction have been in added in Transaction API.
The input filter parameter amount_capturable has been added in List transactions API.
The Event types authorization_succeeded, authorization_voided, order_ready_to_process, order_ready_to_ship have been added.

2018-10-17

The attributes pricing_model and tiers have been added in Addon , Plan and UnbilledCharge resources.
The input parameters 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.
The attributes line_item_tiers has been added in creditNote , Invoice , InvoiceEstimate and CreditNoteEstimate resources.
The attribute pricing_model has been added to line_tem sub-resource of CreditNote , Invoice , InvoiceEstimate and CreditNoteEstimate resources.
The input parameter line_item_amount has been added in Create credit note API.
The input parameters line_item_unit_amount and line_item_quantity have been changed to optional parameters in Create Credit Note API.
The input parameter 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.
The attribute amount has been added to Addon subResource attributes of Subscription API.
The attribute plan_amount has been added to Subscription API.
The type pricing_model with values flat_fee, per_unit, tiered, volume and stairstep have been added.
The values tiered, volume and stairstep have been added to the attribute type of Addon resource.
The values tiered, volume and stairstep have been added to the attribute charge_model of Plan resource.
The input parameter type has been deprecated in Create Addon and Update Addon APIs.
The input parameter charge_model has been deprecated in Create Plan and Update Plan APIs.
The filter parameter type has been deprecated in List Addon API.
The filter parameter charge_model has been deprecated in List Plan API.
The filter parameter pricing_model has been added to List Plan and List Addon APIs.

2018-10-03

The attributes is_shippable, shipping_frequency_period and shipping_frequency_period_unit would be added in Plan and Addon resource.
The input parameters is_shippable, shipping_frequency_period and shipping_frequency_period_unit would be added in Create plan , Update plan , Create addon and Update addon APIs.
The attributes vat_number_validated_time, vat_number_status and is_location_valid would be added in Customer resource.
The event types order_created, order_updated, order_cancelled, order_delivered and order_returned would be added.
New order status queued, awaiting_shipment, on_hold, delivered, shipped, partially_delivered and returned would be added.
The input parameter subscription_affiliate_token would be added to Checkout New Hosted Pages API.
The attributes document_number and order_type would be added to Invoice resource.
The attributes 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.
The input parameters 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.
The filters include_deleted, shipping_date, order_date, paid_on and updated_at would be added in List Orders API.

2018-09-12

The attributes addon_applicability, applicable_addons, attached_addons and event_based_addons have been added to Plan resource.
The input parameters addon_applicability, applicable_addons, attached_addons and event_based_addons have been added in Create plan and Update plan APIs.
The attributes event_based_addons and charged_event_based_addons have been added to Subscription resource.
The input parameters event_based_addons and charged_event_based_addons have been added in Import subscription and Import subscription for customer APIs.

2018-08-17

New endpoint Merge customers has been added to Customer resource.
New endpoint Extend subscription has been added to Hosted page resource.
New endpoint Clear Personal Data of a customer has been added to Customer resource.
The input parameter charges_handling has been added to Resume a subscription and Resume subscription estimate APIs.
The input parameters pause_date and resume_date have been added to Import subscription and Import subscription for customer APIs.
New Tax exempt reason high_value_physical_goods has been added.

2018-06-21

New attribute round_off_amount has been added in Credit Note Estimate and Invoice Estimate sub resources.
New sort_by value updated_at has been added in List Invoice API.
New input parameter bank_account has been added in Create a customer and Create a subscription APIs.
New enums account_holder_type, account_type, echeck_type have been added to bank_account subscription resource in Payment Source resource.
New attributes echeck, account_holder_type, last4 have been added to bank_account subscription resource in Payment Source resource.
New API end point Retrieve Direct Debit Agreement PDF has been added in Hosted Page resource.
New API end points Create bank account payment source and Verify bank account payment source have been added to Payment source resource.

2018-05-23

New resource Exports has been added.
New gateway bluesnap has been added.

2018-05-14

New endpoint List of contacts for a customer has been added.

2018-05-03

New endpoint Update a coupon has been added.

2018-04-27

New resource Virtual Bank Account has been added.
New event types virtual_bank_account_added, virtual_bank_account_updated and virtual_bank_account_deleted have been added.
The payment method ach_credit has been added.

2018-03-29

New status pause has been added to Subscription and Subscription estimate status.
The attribues pause_date and resume_date have been added to Subscription and Estimate resources.
The attributes 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.
The attribute expected_payment_date has been added to Invoice attributes.
The reason code subscription_pause has been added to Credit note attributes.
New event types subscription_paused, subscription_pause_scheduled, subscription_scheduled_pause_removed, subscription_resumed, subscription_resumption_scheduled and subscription_scheduled_resumption_removed have been added.

2018-03-20

New attribute deleted would be added to Payment source resource.

2018-03-08

The input parameter disposition_type has been added to Retrieve Invoice as PDF and Retrieve Credit Note as PDF APIs.

2018-03-02

The attribute balance_currency_code has been deprecated and attribute currency_code has been added to Balances sub-resource in Customer resource.
The attribute done_by has been added to Promotional credits resource.
New payment method wechat_pay has been added.
The endpoint Manage Payment Sources has been undeprecated in Hosted pages resource.

2018-02-01

The attribute round_off_amount have been added to Invoice and Credit note resources.
The attribute settled_at has been added to the Transaction resource.
Collect now API in the Hosted pages resource has been undeprecated.

2018-01-24

New Gateway enum type moneris and moneris_us has been added.

2018-01-12

New endpoint Update invoice details has been added to the Invoices resource.

2017-12-20

New input attribute payment_method_issuing_country has been released in create a customer , update payment method for a customer , create a subscription , update a subscription API
New input attribute issuing_country has been released in create using temporary token and create using permanent token API

2017-12-15

New Event Type subscription_changes_scheduled, subscription_scheduled_changes_removed and pending_invoice_updated has been released
New Gateway Type orbital has been released

2017-11-28

New resource Promotional Credits has been released
New sub resource balances has been added to customer resource
The API end point add_promotional_credits, deduct_promotional_credits and set_promotional_credits has been deprecated in customer resource
New Event Type promotional_credits_added and promotional_credits_deducted has been added

2017-11-14

The new resource Coupon Set has been added
The attribute coupon_set_id has been added to Coupon Code resource
New event type coupon_set_created, coupon_set_updated, coupon_set_deleted, coupon_codes_added, coupon_codes_updated, coupon_codes_deleted
The API end point create a coupon code for a couponhas been deprecated in coupon code resource
The deprecation has been removed for Collect payment for customer in customer resource
New end point Manage payment source and Collect now has been added as deprecated API to hosted page . Please mail us at support@chargebee.com  to enable
New attribute remaining_billing_cycles has been added in addons under subscription resource.

2017-09-28

The deprecation has been removed from parameter vat_number in Hosted pages Checkout new and Checkout existing APIs.
The parameter gateway_meta_data type has been changed to Json in Update a card payment source API.

2017-09-22

New endpoint 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.
The attribute amount_to_collect has been added to Invoice resource.

2017-09-15

The attribute payment_source_id has been added to the transaction resource.
The filter parameter payment_source_id has been added in List transactions API.
The gateway types amazon_payments and paypal_express_checkout has been added.

2017-09-14

The attribute registered_for_gst has been added to the Customer resource.

2017-09-06

The new endpoint Record refund for a credit note has been added to Credit note resource.
The parameter tmp_token has been deprecated in card subresource in Create a customer , Create a subscription , Update a subscription and Import subscription APIs.
The parameter tmp_token has been added to payment method subresource in Create a subscription API.
The type apple_pay has been added to payment method types.

2017-08-31

The parameters credit_option_for_current_term_charges, unbilled_charges_option, refundable_credits_handlingand account_receivables_handling have been added in Cancel subscription API.
A new endpoint Cancel subscription estimate has been added to the Estimate resource.
The attribute deleted has been added to the Unbilled charge resource.
The attribute include_delted has been added to the List unbilled charges API.

2017-08-16

A new endpoint Update a card payment source has been added to the Payment source resource.

2017-08-03

2017-07-26

The new resource Time Machine has been added.

2017-07-21

The new endpoint Change Billing Date has been added to Customer resource.
The new endpoints Upcoming invoices estimate and Subscription change term end estimate have been added to Estimate API.
The attributes billing_date, billing_date_mode, billing_day_of_week, billing_day_of_week_mode, unbilled_charges have been added to the Customer resource.
The parameters line_item_date_from and line_item_date_to have been added to Add Charge API.
The parameters prorate and invoice_immediately have been added Change term end API.

2017-07-06

The parameter status has been added to the Create a plan , Create an addon and Create a coupon APIs.
The attribute issuing_country has been added to the Card and Payment source resource.
The reason code fraudulent has been added to the Credit note resource.
The attribute bank_name is made optional in Bank Account subresource.
The parameter redirect_url has been made optional in Create a portal session API.
The attributes fraud_flag and fraud_reason have been added to the Transaction resource.

2017-06-01

The endpoint Create an estimate for Unbilled charges has been added to the Unbilled Charge resource.
The filter param phone has been added to the List Customer API.
The list subresource invoice_estimates has been added to the Estimate resource.

2017-05-04

The new resources Payment Source and Unbilled Charge have been added.
The attribute payment_source_id has been added to the Card resource.
The attribute subscription_id has been added to the lineitems subresource in Invoice , Credit Note , Invoice estimate , Next invoice estimate and Credit Note estimate .
The attributes consolidated_invoicing, primary_payment_source_id, backup_payment_source_id and the subresource list referral_urls have been added to the Customer resource.
The attributes payment_source_id and auto_collection have been added to the Subscription resource.
The subresource unbilled_charge_estimates has been added to the Estimate resource.
The param consolidated_invoicing has been added to Create a customer and Update a customer APIs.
The endpoint Assign payment role has been added to the Customer resource.
The endpoint Override Billing Profile has been added to the Subscription resource.
The input params auto_collection, invoice_immediately and consolidated_invoicing have been added to Create subscription API.
The input params auto_collection, payment_source_id and invoice_immediately have been added to Create subscription for customer API.
The input param auto_collection has been added to the Subscription subresource and consolidated_invoicing has been added to the Customer subresource in Checkout new subscription API.
The event types payment_source_added, payment_source_updated and payment_source_deleted have been added.

2017-04-19

The endpoints List and Acknowledge APIs have been added to the Hosted page resource.
A new subresource line_item_discounts has been added to the Invoice , Credit note , Invoice estimates and Credit note estimates resources.
The Card statuses pending_verification and invalid have been added to the Customer resource.
The Payment Method types generic, alipay and unionpay have been added to the Payment Method type in the Customer resource.
The state failed and the attribute failure_reason have been deprecated in the Hosted Page resource.
The attribues updated_at, resource_version and checkout_info have been added to the Hosted Page resource.
A new gateway adyen has been added.

2017-03-16

The input parameter id has been removed in Update a Plan and Update an addon resources.
The filter input parameter next_billing_at has been added in List Subscriptions API.
The input parameter force_term_reset has been added to Checkout existing hosted pages API.
A new attribute has_advance_charges has been added to the Invoice resource.

2017-02-24

New resources Site Migration Details and Resource Migrations have been added.
The attributes id and for_site_merging have been added to Copy an addon , Copy a coupon and Copy a plan API.
A new endpoint Move a customer has been added.
The event types customer_moved_out and customer_moved_in have been added.
The input parameters ignore_scheduled_cancellation and ignore_scheduled_changes have been added to the Subscription renewal estimate API.

2017-01-30

A new reason code Subscription cancellation has been added to the Credit note resource.
A new attribute next_billing_at has been added to the Subscription resource.
The input parameters terms_to_charge, reactivate, reactivate_from have been added to Update a Subscription , Update subscription estimate and Checkout existing hosted page APIs.
The input parameter reactivate_from has been added to Reactivate a subscription API.
A new endpoint Charge Future Renewals has been added to the Subscription API.

2017-01-27

A new attribute 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.
An input param 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.
An input param fraud_flag has been added to Update customer API.
An input param 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.
An input param 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.
New input params billing_address and shipping_address has been added to Checkout new hosted page API.
A new endpoint Create subscription for a customer estimate has been added to the Estimate resource.

2017-01-12

A new endpoint Unarchive a plan has been added to the Plan resource.
A new endpoint Unarchive an addon has been added to the Addon resource.
A new endpoint Unarchive a coupon has been added to the Coupon resource.

2016-12-30

The attributes plan_unit_price, setup_fee, billing_period, billing_period_unit and plan_free_quantity have been added to the Subscription resource.
An input parameter Addon 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.

2016-12-09

A new attribute, locale has been added to the Customer resource.
The attributes mrr, exchange_rate and base_currency_code have been added to the Subscription resource.
A new filter parameter cancelled_at has been added to List Subscription API.
The attribute 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.
The attributes sku, accounting_code, accounting_category1 and accounting_category2 have been added to the Plan and the Addon resource.
The input parameters 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.
The input parameters transaction_id_at_gateway, transaction_status, transaction_error_code and transaction_error_text have been added to Record an invoice payment API.

2016-11-24

A new attribute, funding_type has been added to Card resource.
A new endpoint, List coupon codes API has been added to Coupon Code resource.
A new endpoint, Copy a plan API has been added to Plan resource.
A new endpoint, Copy an addon API has been added to Addon resource.
A new endpoint, Copy a coupon API has been added to Coupon resource.
A new endpoint, Import a subscription and Import Subscription for customer APIs have been added to Subscription resource.
A new endpoint, Import invoice API has been added to Invoice resource.

2016-11-18

The attribute tax_profile_id will be added to Plan , and Addon resources.
A new input parameter, tax_profile_id will be added to Create plan , Update a plan , Create an addon , and Update an addon APIs.
A new Subscription cancel reason type non_compliant_customer will be added. Refer to Subscription attributes for more information.

2016-11-09

The attributes updated_at and resource_version have been added to Plan , Addon , and Coupon resources.
The following Event Types have been introduced: plan_created, plan_updated, plan_deleted, addon_created, addon_updated, addon_deleted, coupon_created, coupon_updated, coupon_deleted, netd_payment_due_reminder.
The new Invoice status posted has been added. Refer to Invoice attributes for more information.
The attribute 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.
The attributes net_term_days and due_date have been added to the Invoice resource.

2016-10-27

The attribute 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.

2016-10-07

The parameter 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.
Two new parameters force_term_reset and replace_coupon_list have been added to Update a subscription and Update subscription estimate APIs.

2016-09-30

The new attributes updated_at, resource_version, and deleted will be returned as part of Customer , Subscription , Invoice , Credit Note , and Transaction resources.
A new parameter, include_deleted has been added to Customer , Subscription , Invoice , Credit Note , and Transaction List APIs.
A new parameter, date has been added to Create Credit Note API.

2016-09-21

A new Gateway type gocardless has been added for Card resource.

2016-09-03

A new endpoint to Create Credit Note has been added.
A new endpoint to Write off an invoice has been added.
A new input parameter forward_url has been added for Create a portal session API.

2016-08-25

The attribute validation_status has been added to address .
The attribute 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.
The attribute 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.
The attribute validation_status will be returned as part of billing and shipping address in Invoice resource.
The attribute created_from_ip, card_ip_address has been deprecated from Customer and Subscription resource.
The input parameter 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.
The status pending_verification has been added to the subresource attribute Payment Method status.

2016-08-02

A new endpoint Retrieve Credit Note as PDF has been added.
The attribute invoice_notes has been added to subscription in Hosted Pages Checkout new and Checkout existing APIs.
The filter parameter paid_at has been added to List invoices API and the parameter paid_on_after has been deprecated.
The filter parameters 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.

2016-07-18

A new endpoint Remove coupons has been added.
A new endpoint Record an excess payment for a customer has been added.

2016-07-06

A new endpoint Delete a coupon has been added.

2016-07-04

The attribute currency_code has been added as part of Plans , Addons , Coupons , Subscription , Transaction , and Estimate resources.

2016-06-27

A new resource third_party_payment_method will be returned on performing Copy card API.

2016-06-16

A new subresource next_invoice_estimate will be returned as part of the Estimate resource.

2016-05-24

A new attribute currency_code will be returned as part of the Credit Note resource.
A new Gateway type wepay has been added for the Card resource.