POpolar
orders
public

Update Order

Changed on

Update an order.

Scopes: orders:write

patch/v1/orders/{id}

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/orders/{id}
  • 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

billing_namestring nullable

The name of the customer that should appear on the invoice.

Example request

{
  "billing_address": {
    "country": "US"
  }
}

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