Stay up to date with the latest changes, improvements and deprecations to the Polar API.
customer_external_id
field to external_customer_id
in the Checkout API and Customer Session API.customer_external_id
field in the Checkout API and Customer Session API. Use
external_customer_id
instead.granted_benefits
list.GET /v1/orders/{id}/invoice
and GET /v1/customer-portal/orders/{id}/invoice
endpoints without any prior action.We now require you to explicitly generate the invoice by calling the POST /v1/orders/{id}/invoice
or POST /v1/customer-portal/orders/{id}/invoice
endpoints.This change allows us to better handle the invoice generation process, and to allow the customer to change the billing details (name and address) before generating the invoice. This can be done through the PATCH /v1/orders/{id}
or PATCH /v1/customer-portal/orders/{id}
endpoints.checkout.discount_amount
.checkout.net_amount
.checkout.subtotal_amount
, use
checkout.net_amount
instead.pending
, which is a transitive state meaning the order is created but not paid yet. In most cases, the order will transition from pending
to paid
in a short time.order.created
event, the order status might not be paid
.order.updated
webhook, sent when
the order status changes or when it’s partially or fully refunded.order.paid
webhook, sent when the
order is fully processed and paid.Order.paid
property to the order
schema.order.created
webhook to keep track of succesful
orders, we recommend you to switch to order.paid
.Subscription
and Order
schemas. The main reason behind those is that we need to support multiple prices and items in a single subscription or order.Subscription.price_id
and Subscription.price
. Use the
Subscription.prices
array instead.Order.product_price_id
and Order.product_price
. Use the Order.items
array instead.Order.amount
. Use the Order.net_amount
instead. It has the same value and
meaning, but the new name is more explicit.Order.subtotal_amount
, Order.discount_amount
, and Order.total_amount
fields to provide a more detailed breakdown of the order amount.