API upgrades

​

July 21, 2025

• Added Subscription.crm_opportunity_id on /v2/subscriptions POST endpoint
• Added Subscription.crm_opportunity_id on /v2/subscriptions/{id} PUT endpoint

​

July 17, 2025

• Added reason on /v1/subscriptions/{id}/cancel POST endpoint
• Added Subscription.cancellation_reason on /v2/subscriptions GET endpoint
• Added Subscription.cancellation_reason on /v2/subscriptions/{id} GET endpoint

​

July 11, 2025

• Added /v1/customers/{id}/payment-methods POST endpoint
• Added Transaction.provider_name and Transaction.provider_transaction_id on /v1/invoices/{id}/transactions POST endpoint

​

July 7, 2025

• Added /v1/files GET, POST endpoints
• Added /v1/files/{id} DELETE endpoint
• Added /v1/files/{id}/download GET endpoint
• Added Invoice.properties on /v1/invoices GET, POST endpoints
• Added Invoice.properties on /v1/invoices/{id} GET, PATCH endpoints

​

July 3, 2025

• Added /v1/subscriptions/{id}/renew POST endpoint

​

June 27, 2025

• Added Invoice.coupons and Invoice.transactions on /v1/invoices GET endpoint

​

June 18, 2025

• Added Subscription.name on /v2/subscriptions/{subscriptionId} GET endpoint
• Added Subscription.name on /v2/subscriptions GET endpoint

​

June 13, 2025

• Added Subscription.generate_document, Subscription.document_name and Subscription.add_vat_to_document on /v2/subscriptions POST endpoint

​

June 11, 2025

• Added /v1/invoices/{id}/credit-notes POST endpoint
• Added Invoice.integrations on /v1/invoices/{id} GET endpoint
• Added Customer.integrations on /v1/customers/{id} GET endpoint
• Added PaymentMethod.integration on /v1/customers/{id}/payment-methods/{id} GET endpoint
• Major Deprecation warning
  • Deprecating Customer.providers in favor of Customer.integrations

​

June 6, 2025

• Added /v1/price-configurations GET endpoint
• Added /v1/price-configurations/{id} DELETE endpoint

​

May 16, 2025

• Added purchase_order filter on /v2/subscriptions GET endpoint

​

May 9, 2025

• Added /v1/promotion-codes GET, POST endpoints
• Added /v1/promotion-codes/{id} GET, PATCH, DELETE endpoints

​

April 30, 2025

• Added Subscription.contract_terms on /v2/subscriptions/{subscriptionId} GET endpoint
• Added Subscription.contract_terms on /v2/subscriptions POST endpoint
• Added Quote.subscription.contract_terms on /v1/quotes POST endpoint
• Added Invoice.bank_account_id on /v1/invoices/{id} GET endpoint
• Added Invoice.bank_account_id on /v1/invoices/{id} PATCH endpoint
• Added Invoice.payment_method_type on /v1/invoices/{id} PATCH endpoint
• Added Invoice.payment_method_id on /v1/invoices/{id} PATCH endpoint

​

April 18, 2025

• Added Subscription.billing_cycle_alignment on /v2/subscriptions POST endpoint

​

April 8, 2025

• Added Invoice.type on /v1/invoices POST endpoint
• Added Invoice.type on /v1/invoices/{id} PATCH endpoint
• Added Invoice.document_name on /v1/invoices POST endpoint
• Added Invoice.document_name on /v1/invoices/{id} PATCH endpoint
• Added Invoice.tax_scheme on /v1/invoices POST endpoint
• Added Invoice.tax_scheme on /v1/invoices/{id} PATCH endpoint
• Added Invoice.line_items on /v1/invoices/{id} PATCH endpoint

​

April 4, 2025

• Added Subscription.trial on /v2/subscriptions POST endpoint
• Added Quote.subscription.trial on /v1/quotes POST endpoint
• Major Deprecation warning
  • Deprecating Subscription.trial_ends_at and Subscription.trial_delay_first_invoice in favor of Subscription.trial
  • Deprecating Quote.subscription.trial_ends_at and Quote.subscription.trial_delay_first_invoice in favor of Quote.subscription.trial

​

March 31, 2025

• Added /v1/invoices/{id}/charge POST endpoint
• Added Invoice.transactions[].chargeback on /v1/invoices/{id} GET endpoint
• Added Subscription.phases[].billing_cycle_alignment on /v2/subscriptions/{subscriptionId} GET endpoint
• Added SubscriptionPhase.billing_cycle_alignment on /v2/subscriptions/{subscriptionId}/phases GET endpoint
• Added SubscriptionPhase.billing_cycle_alignment on /v2/subscriptions/{subscriptionId}/phases/{phaseId} GET endpoint
• Added Subscription.phases[].billing_cycle_alignment on /v2/subscriptions POST endpoint
• Added Quote.subscription.phases[].billing_cycle_alignment on /v1/quotes POST endpoint
• Added subscription.reinstated webhook

​

March 24, 2025

• Added PaymentMethod.status on /v1/customers/{id}/payment-methods GET endpoint
• Added PaymentMethod.status on /v1/customers/{id}/payment-methods/{paymentMethodId} GET endpoint
• Added Customer.price_book_id on /v1/customers GET endpoint
• Added Customer.price_book_id on /v1/customers/{id} GET endpoint

​

March 11, 2025

• Added /v1/products/{id}/archive PUT endpoint
• Added /v1/products/{id}/unarchive PUT endpoint

​

March 6, 2025

• Added /v1/invoices/{id}/transactions POST endpoint
• Added /v1/invoices/{id}/transactions/{transactionId} DELETE endpoint
• Added provider_id on /v1/customers/providers-bulk-update POST endpoint

​

February 27, 2025

• Added Subscription.phases on /v2/subscriptions POST endpoint
• Added Subscription.phases on /v2/subscriptions/{id} GET endpoint

​

February 4, 2025

• Added Invoice.payment_method_id on /v1/invoices POST endpoint
• Added Invoice.line_items[].tax_rate on /v1/invoices POST endpoint

​

January 28, 2025

• Added Invoice.line_items[].product_id on /v1/invoices POST endpoint

​

January 15, 2025

• Added Subscription.quote on /v2/subscriptions/{id} GET endpoint

​

January 14, 2025

• Added /v2/subscriptions/{id}/phases GET endpoint
• Added /v2/subscriptions/{id}/phases/{phaseId} GET endpoint
• Added Subscription.current_phase_id on /v2/subscriptions GET endpoint
• Added Subscription.current_phase_id on /v2/subscriptions/{id} GET endpoint

​

January 10, 2025

• Added Quote.original_subscription_id on /v1/quotes GET endpoint
• Added Quote.original_subscription_id on /v1/quotes/{id} GET endpoint

​

January 8, 2025

• Added /v1/invoices/{id} DELETE endpoint

​

November 6, 2024

• Added /v1/customers/{id}/unarchive PUT endpoint
• Added /v1/invoices/{id} PATCH endpoint
• Added /v1/subscriptions/{id}/activate POST endpoint

​

October 23, 2024

• Added /v1/customers/{id}/payment-methods GET endpoint
• Added /v1/customers/{id}/payment-methods/{paymentMethodId} GET, DELETE endpoints

​

October 8, 2024

• Added /v1/companies POST endpoint

​

August 21, 2024

• Added custom_property.created, custom_property.updated, custom_property.deleted, custom_property.value_created, custom_property.value_updated, bank_account.created, bank_account.deleted webhooks

​

August 20, 2024

• Added /v1/taxes/rates GET endpoint
• Added /v1/taxes/rates/{id} GET endpoint
• Added Product.accounting on /v1/products/{id} GET, POST, PUT endpoints
• Added Invoice.line_items[].tax_rate_id on /v1/invoices GET endpoint
• Added Invoice.line_items[].tax_rate_id on /v1/invoices/{id} GET endpoint
• Added Customer.custom_payment_delay on /v1/customers GET endpoint
• Added Customer.custom_payment_delay on /v1/customers/{id} GET, POST, PUT endpoints

​

August 12, 2024

• Added Subscription.custom_properties on /v2/subscriptions GET, POST endpoints
• Added Subscription.custom_properties on /v2/subscriptions/{id} GET, PUT endpoints

​

August 7, 2024

• Added /v1/quotes/{id}/sign POST endpoint
• Added /v1/invoices/{id}/void POST endpoint

​

July 30, 2024

• Added Customer.timezone on /v1/customers GET, POST endpoints
• Added Customer.timezone on /v1/customers/{id} GET, PUT endpoints
• Subscription.payment_method_strategy is now optional on /v2/subscriptions POST endpoint

​

July 3, 2024

• Added /v1/organisations/{id} GET endpoint
• Added /v1/organisations/{id} PATCH endpoint
• Added Customer.organisation_id and Customer.organisation_invoicing on /v1/customers POST endpoint
• Added Customer.organisation_id and Customer.organisation_invoicing on /v1/customers/{id} GET, PUT endpoints
• Added Subscription.contract_start and Subscription.contract_end on /v2/subscriptions/* endpoints
• Added Subscription.products[].attached_at and Subscription.products[].detached_at on /v2/subscriptions/* endpoints
• Added /v1/subscriptions/{id}/reinstate POST endpoint
• Added update_prices SubscriptionUpdate.type on /v1/subscriptions/{id}/update POST endpoint
• Added /v1/subscriptions/{id}/update-many POST endpoint
• Major Deprecation warning
  • Deprecating Subscription.starts_at in favor of Subscription.contract_start
• Major Planned for September 1, 2024
  • Removing SubscriptionUpdate.payload.billing_item_ids in favor of SubscriptionUpdate.payload.product_ids for add_coupon update type
  • Removing add_item SubscriptionUpdate.type in favor of add_product
  • Removing remove_item SubscriptionUpdate.type in favor of remove_product

​

June 26, 2024

• Added /v1/quotes POST endpoint
• Added /v1/quotes/{id}/download GET endpoint
• Added /v1/quotes/{id}/send POST endpoint
• Added /v1/quotes/{id}/void POST endpoint

​

June 12, 2024

• Add Customer.custom_properties on /v1/customers GET endpoint

​

May 27, 2024

• Added /v1/quotes GET endpoint
• Added /v1/quotes/{id} GET endpoint
• Added /v1/quotes/{quoteId}/files/{id}/download GET endpoint

​

April 2, 2024

• Major Removed deprecated subscription endpoints
  • Removed GET /v1/subscriptions in favor of GET /v2/subscriptions
  • Removed GET /v1/subscriptions/{id} in favor of GET /v2/subscriptions/{id}
  • Removed POST /v1/subscriptions in favor of POST /v2/subscriptions
  • Removed GET /v1/billing-plans/{id} in favor of GET /v1/plans/{id}
  • Removed GET /v1/billing-scenarios
  • Removed GET /v1/billing-scenarios/{id}

​

March 6, 2024

• Added /v1/subscriptions/{id}/pause PUT endpoint
• Added /v1/subscriptions/{id}/reactivate PUT endpoint
• Added /v1/subscriptions/refresh POST endpoint

​

March 5, 2024

• Added /v1/webhooks/endpoints GET, POST endpoints
• Added /v1/webhooks/endpoints/{id} GET, PUT, DELETE endpoints

​

March 1, 2024

• Major Removed unit concept on wallets (only money pocket) in favor of credit-type products to manage credit units.
  • Removed WalletBalance.units
  • Removed WalletSettings.unit_credit_prices
  • Removed WalletTransaction.units and WalletTransaction.transaction_id

​

February 28, 2024

• Major Removed unique current customer subscription in favor of subscriptions array.
  • Removed Customer.current_subscription_id on /v1/customers GET endpoint
  • Removed Customer.current_subscription on /v1/customers/{id} GET endpoint

​

February 20, 2024

• Added Customer.type on /v1/customers GET, POST and PUT endpoints
• Added Customer.invoice_emails on /v1/customers GET, POST and PUT endpoints
• Added Customer.vat_rate_custom on /v1/customers GET, POST and PUT endpoints
• Added external option on Customer.payment_method_type on /v1/customers POST and PUT endpoints

​

February 16, 2024

• Major Planned for April 1, 2024
  • Removing Customer.country in favor of Customer.billing_address.country
  • Removing GET /v1/subscriptions in favor of GET /v2/subscriptions
  • Removing GET /v1/subscriptions/{id} in favor of GET /v2/subscriptions/{id}
  • Removing POST /v1/subscriptions in favor of POST /v2/subscriptions
• Major Planned for February 28, 2024
  • Removing Customer.current_subscription_id on /v1/customers GET endpoint in favor of Customer.subscriptions
  • Removing Customer.current_subscription on /v1/customers/{id} GET endpoint in favor of Customer.subscriptions