API Changelog

Keep up to date with changes to our API.

  1. September 10th, 2024

    • Added fraudulent Order status to indicate that an order has been marked as fraudulent.

  2. September 4th, 2024

    • Added new Issue an Order refund endpoint.
    • Added new Issue a Subscription Invoice refund endpoint.
    • Deprecated dark option in the checkout_options attribute when creating a new checkout. Use the new color options instead.
    • Added the following options to the checkout_options attribute to allow overriding checkout styles when creating a new checkout:
      • background_color
      • headings_color
      • primary_text_color
      • secondary_text_color
      • links_color
      • borders_color
      • checkbox_color
      • active_state_color
      • button_color
      • button_text_color
      • terms_privacy_color

  3. August 7th, 2024

  4. June 9th, 2024

  5. May 20th, 2024

  6. April 9th, 2024

  7. March 28th, 2024

    • You now can modify the trial_ends_at value using the update subscription API endpoint to adjust the duration of free trials for existing Subscriptions.
    • Checkout options now include a skip_trial attribute that allows you to create a Custom Checkout without a trial for a variant that typically offers a free trial by default.

  8. February 20th, 2024

  9. February 12th, 2024

  10. February 5th, 2024

  11. January 21st, 2024

    • Added setup_fee_enabled and setup_fee parameters to Price objects
    • Added setup_fee, setup_fee_usd, and setup_fee_formatted parameters to Order objects

  12. January 15th, 2024

  13. January 11th, 2024

  14. January 5th, 2024

  15. December 21st, 2023

  16. December 6th, 2024

  17. October 20th, 2023

  18. October 2nd, 2023

    • We updated our docs regarding subscription proration, specifically how the disable_prorations option works.

  19. September 19th, 2023

  20. August 23rd, 2023

  21. August 14th, 2023

    • We added customer_id, user_name and user_email values to Subscription invoice objects to make it easier to match invoices with customers in your application.

  22. July 20th, 2023

    • We updated the status values in Subscription invoice objects in the docs to properly match API responses.

  23. July 19th, 2023

  24. July 5th, 2023

  25. June 27th, 2023

    • We added a new license_key_updated webhook event so you can now watch for license key updates and update your application accordingly. There is also a new “License key updated” trigger in our Zapier integration.

  26. May 25th, 2023

    • New endpoints: We’ve just added new Webhook endpoints so you can now query, create, update and delete webhooks using the API.

  27. May 12th, 2023

  28. April 17th, 2023

  29. March 30th, 2023

  30. March 17th, 2023

    • We added a new subscription_updated webhook event to make it easier to keep your local subscription data up-to-date (make sure you subscribe to this event from your existing webhooks). There is also a new “Subscription updated” trigger in our Zapier integration.
    • Custom data added to checkouts is now saved permanently and is available in all Order, Subscription and License key related webhooks.
    • We’ve added customer_id to Order, Subscription and License key objects, so you can now easily link customers to other objects. You can also now include customer objects in order, subscription and license key API calls.
    • card_brand and card_last_four values are now available in Subscription objects.
    • The subscription_payment_success webhook event is now sent for initial subscription payments as well as renewals.
    • billing_anchor can now be set to null or 0 to reset it to the current date. Read more →

  31. February 17th, 2023

  32. February 7th, 2023

    • New endpoints: We’ve added new Discount redemption endpoints so you can easily query discount usage.
    • The update subscription API endpoint now has a disable_prorations flag to help manage proration. Read more →

  33. February 6th, 2023

    • The create checkout endpoint now has a preview option, which returns a preview object containing the checkout totals with discounts and tax taken into account.

  34. February 4th, 2023

    • We added product_name, variant_name, customer_id, customer_name, and customer_email to the meta object in the License API.

  35. January 25th, 2023

    • New endpoints: We just added Subscription invoices endpoints, meaning it’s possible to query billing histories for your subscriptions.

  36. January 23rd, 2023

  37. January 9th, 2023

    • You can now manually simulate subscription events from within your Dashboard. Read more →

  38. January 5th, 2023

    • The update subscription API endpoint now has a invoice_immediately flag to help manage renewal invoices. Read more →

  39. December 13th, 2022

    • New endpoint: We’ve added Customers endpoints so you can retrieve customer data over the API.
    • Order objects now contain a first_order_item object to reduce the number of API calls required.

  40. October 26th, 2022

    • Our new Subscription API allows SaaS businesses to control the entire subscription experience end-to-end.

Previous

← Responses

Next

Users →
Was this page helpful?