Webhook Events

checkout.session.expired

Fired when a Checkout Session times out without payment; draft records are cleaned up. Doc-only for parsing.

post/webhook-events/checkout.session.expired

Response

Webhook payload

event_type'subscription.created' | 'subscription.draft.created' | 'subscription.activated' | 'subscription.updated' | 'subscription.paused' | 'subscription.cancelled' | 'subscription.resumed' | 'subscription.plan_changed' | 'subscription.phase.created' | 'subscription.phase.updated' | 'subscription.phase.deleted' | 'feature.created' | 'feature.updated' | 'feature.deleted' | 'feature.wallet_balance.alert' | 'entitlement.created' | 'entitlement.updated' | 'entitlement.deleted' | 'wallet.created' | 'wallet.updated' | 'wallet.terminated' | 'wallet.transaction.created' | 'wallet.transaction.updated' | 'payment.created' | 'payment.updated' | 'payment.failed' | 'payment.success' | 'payment.pending' | 'customer.created' | 'customer.updated' | 'customer.deleted' | 'invoice.update.finalized' | 'invoice.update.payment' | 'invoice.update.voided' | 'invoice.update' | 'invoice.payment.overdue' | 'wallet.credit_balance.dropped' | 'wallet.credit_balance.recovered' | 'wallet.ongoing_balance.dropped' | 'wallet.ongoing_balance.recovered' | 'wallet.ongoing_balance.updated' | 'subscription.spend.threshold_reached' | 'subscription.spend.threshold_recovered' | 'subscription.line_item_spend.threshold_reached' | 'subscription.line_item_spend.threshold_recovered' | 'subscription.group_spend.threshold_reached' | 'subscription.group_spend.threshold_recovered' | 'entitlement.grant.exhausted' | 'subscription.renewal.due' | 'invoice.communication.triggered' | 'credit_note.created' | 'credit_note.updated' | 'checkout.session.initiated' | 'checkout.session.completed' | 'checkout.session.failed' | 'checkout.session.expired' | 'event.rejected'

Changes

Changed in 3 of the 108 revisions of this API.213

    • removed the optional property checkout_session/cancel_url from the response with the 200 status

      response-optional-property-removed

    • removed the optional property checkout_session/configuration from the response with the 200 status

      response-optional-property-removed

    • removed the optional property checkout_session/created_at from the response with the 200 status

      response-optional-property-removed

    • removed the optional property checkout_session/created_by from the response with the 200 status

      response-optional-property-removed

    • removed the optional property checkout_session/environment_id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property checkout_session/failure_url from the response with the 200 status

      response-optional-property-removed

    • removed the optional property checkout_session/idempotency_key from the response with the 200 status

      response-optional-property-removed

    • removed the optional property checkout_session/metadata from the response with the 200 status

      response-optional-property-removed

    • removed the optional property checkout_session/payment_provider_config from the response with the 200 status

      response-optional-property-removed

    • removed the optional property checkout_session/provider_result from the response with the 200 status

      response-optional-property-removed

    • removed the optional property checkout_session/result from the response with the 200 status

      response-optional-property-removed

    • removed the optional property checkout_session/status from the response with the 200 status

      response-optional-property-removed

    • removed the optional property checkout_session/success_url from the response with the 200 status

      response-optional-property-removed

    • removed the optional property checkout_session/tenant_id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property checkout_session/updated_at from the response with the 200 status

      response-optional-property-removed

    • removed the optional property checkout_session/updated_by from the response with the 200 status

      response-optional-property-removed

    • added the new add_addon enum value to the checkout_session/action response property for the response status 200

      response-property-enum-value-added

    • added the new subscription.plan_changed enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 50b7421a969032See the full diff
    • added the new entitlement.grant.exhausted enum value to the event_type response property for the response status 200

      response-property-enum-value-added

    • added the new modify_subscription enum value to the checkout_session/action response property for the response status 200

      response-property-enum-value-added

    • added the new wallet_topup enum value to the checkout_session/action response property for the response status 200

      response-property-enum-value-added

    • added the optional property checkout_session/configuration/modify_subscription_params to the response with the 200 status

      response-optional-property-added

    • added the optional property checkout_session/configuration/wallet_topup_params to the response with the 200 status

      response-optional-property-added

    • endpoint added

      endpoint-added