Documentation
checkouts

Update Checkout Session

patch
/v1/checkouts/custom/{id}
Update a checkout session.

Key-value object allowing you to store additional information.

The key must be a string with a maximum length of 40 characters. The value must be a string with a maximum length of 500 characters. You can store up to 50 key-value pairs.

curl -X PATCH \
    'https://api.polar.sh/v1/checkouts/custom/00000000-0000-0000-0000-000000000000' \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "Authorization: Bearer <token>" \
    -d '{}'
Responses
{
  "created_at": "2024-10-16T00:00:00.000Z",
  "modified_at": "2024-10-16T00:00:00.000Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "payment_processor": "stripe",
  "status": "open",
  "client_secret": "string",
  "expires_at": "2024-10-16T00:00:00.000Z",
  "success_url": "string",
  "amount": 0,
  "tax_amount": 0,
  "currency": "string",
  "total_amount": 0,
  "product_id": "00000000-0000-0000-0000-000000000000",
  "product_price_id": "00000000-0000-0000-0000-000000000000",
  "is_payment_required": false,
  "customer_id": "00000000-0000-0000-0000-000000000000",
  "customer_name": "string",
  "customer_email": "string",
  "customer_ip_address": "string",
  "customer_billing_address": {
    "line1": "string",
    "line2": "string",
    "postal_code": "string",
    "city": "string",
    "state": "string",
    "country": "string"
  },
  "customer_tax_id": "string",
  "payment_processor_metadata": {},
  "metadata": {},
  "url": "string"
}