POpolar
orders
public

Finalize Order

Changed on

Finalize a draft order and synchronously attempt an off-session charge.

On success, the order transitions to paid and benefit grants fire before the response returns. On failure (decline, missing payment method, SCA challenge), the order stays in draft and a 4xx error is returned.

The request fails with 412 if the order is not in draft status.

Scopes: orders:write

post/v1/orders/{id}/finalize

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/orders/{id}/finalize
  • Auth
    • OpenID Connect (/.well-known/openid-configuration, scopes: orders:write)
    • or HTTP bearer
    • or HTTP bearer

Path parameters

idstring uuid4 required

The order ID.

Request body

payment_method_idstring uuid4 nullable

ID of the payment method to charge. Must belong to the order's customer. Falls back to the customer's default payment method when unset.

Response

Successful Response

Order required(unresolved $ref)

Changes

  • 77e4ef94fcc3Revision changes
    • warning

      added the new subscription_meter_cycle enum value to the response property for the response status

  • f9688fd328d6Revision changes
    • info

      added the required property / to the response with the status