WebhookAPIVersion

  • Type: string enum

    Payload schema version used for every event delivered to the endpoint. The version is selected when the endpoint is created and cannot be updated.

    values
    • v1

      Legacy Checkout Session and Payment Intent payload shapes. Used when api_version is omitted for backward compatibility.

    • v2

      Recommended for new integrations. Uses the current Checkout Session and Payment Intent resource shapes.

Examples
v2