Webhooks
ModelsExpand Collapse
type ConnectionCreatedWebhookEvent struct{…}
Data ConnectionCreatedWebhookEventDataThe payment request, as returned by
GET /v3/payment_requests/{paymentRequestId}.
The payment request, as returned by
GET /v3/payment_requests/{paymentRequestId}.
What was charged at checkout, in the currency’s minor
units. In subscription mode this is the first invoice’s
total — all items after any discounts are applied.
Status string
Discount ConnectionCreatedWebhookEventDataDiscountOptionalSubscription mode — the discount Stripe applied, read back
from the coupon. Absent when none was applied.
Subscription mode — the discount Stripe applied, read back from the coupon. Absent when none was applied.
Interval stringOptionalSubscription mode — how often the subscription renews.
Subscription mode — how often the subscription renews.
Natural ConnectionCreatedWebhookEventDataNaturalOptionalNatural-rail join keys, present when rail: natural.
Natural-rail join keys, present when rail: natural.
Stripe ConnectionCreatedWebhookEventDataStripeOptionalIds of the Stripe objects on your connected account — join
keys into your own Stripe Dashboard/API. Manage a
subscription’s post-checkout lifecycle with subscription_id.
Ids of the Stripe objects on your connected account — join
keys into your own Stripe Dashboard/API. Manage a
subscription’s post-checkout lifecycle with subscription_id.
EventType ConnectionCreatedWebhookEventEventType
type ConnectionRevokedWebhookEvent struct{…}
Data ConnectionRevokedWebhookEventDataThe payment request, as returned by
GET /v3/payment_requests/{paymentRequestId}.
The payment request, as returned by
GET /v3/payment_requests/{paymentRequestId}.
What was charged at checkout, in the currency’s minor
units. In subscription mode this is the first invoice’s
total — all items after any discounts are applied.
Status string
Discount ConnectionRevokedWebhookEventDataDiscountOptionalSubscription mode — the discount Stripe applied, read back
from the coupon. Absent when none was applied.
Subscription mode — the discount Stripe applied, read back from the coupon. Absent when none was applied.
Interval stringOptionalSubscription mode — how often the subscription renews.
Subscription mode — how often the subscription renews.
Natural ConnectionRevokedWebhookEventDataNaturalOptionalNatural-rail join keys, present when rail: natural.
Natural-rail join keys, present when rail: natural.
Stripe ConnectionRevokedWebhookEventDataStripeOptionalIds of the Stripe objects on your connected account — join
keys into your own Stripe Dashboard/API. Manage a
subscription’s post-checkout lifecycle with subscription_id.
Ids of the Stripe objects on your connected account — join
keys into your own Stripe Dashboard/API. Manage a
subscription’s post-checkout lifecycle with subscription_id.
EventType ConnectionRevokedWebhookEventEventType
type PaymentAuthorizedWebhookEvent struct{…}
Data PaymentAuthorizedWebhookEventDataThe payment request, as returned by
GET /v3/payment_requests/{paymentRequestId}.
The payment request, as returned by
GET /v3/payment_requests/{paymentRequestId}.
What was charged at checkout, in the currency’s minor
units. In subscription mode this is the first invoice’s
total — all items after any discounts are applied.
Status string
Discount PaymentAuthorizedWebhookEventDataDiscountOptionalSubscription mode — the discount Stripe applied, read back
from the coupon. Absent when none was applied.
Subscription mode — the discount Stripe applied, read back from the coupon. Absent when none was applied.
Interval stringOptionalSubscription mode — how often the subscription renews.
Subscription mode — how often the subscription renews.
Natural PaymentAuthorizedWebhookEventDataNaturalOptionalNatural-rail join keys, present when rail: natural.
Natural-rail join keys, present when rail: natural.
Stripe PaymentAuthorizedWebhookEventDataStripeOptionalIds of the Stripe objects on your connected account — join
keys into your own Stripe Dashboard/API. Manage a
subscription’s post-checkout lifecycle with subscription_id.
Ids of the Stripe objects on your connected account — join
keys into your own Stripe Dashboard/API. Manage a
subscription’s post-checkout lifecycle with subscription_id.
EventType PaymentAuthorizedWebhookEventEventType
type PaymentCanceledWebhookEvent struct{…}
Data PaymentCanceledWebhookEventDataThe payment request, as returned by
GET /v3/payment_requests/{paymentRequestId}.
The payment request, as returned by
GET /v3/payment_requests/{paymentRequestId}.
What was charged at checkout, in the currency’s minor
units. In subscription mode this is the first invoice’s
total — all items after any discounts are applied.
Status string
Discount PaymentCanceledWebhookEventDataDiscountOptionalSubscription mode — the discount Stripe applied, read back
from the coupon. Absent when none was applied.
Subscription mode — the discount Stripe applied, read back from the coupon. Absent when none was applied.
Interval stringOptionalSubscription mode — how often the subscription renews.
Subscription mode — how often the subscription renews.
Natural PaymentCanceledWebhookEventDataNaturalOptionalNatural-rail join keys, present when rail: natural.
Natural-rail join keys, present when rail: natural.
Stripe PaymentCanceledWebhookEventDataStripeOptionalIds of the Stripe objects on your connected account — join
keys into your own Stripe Dashboard/API. Manage a
subscription’s post-checkout lifecycle with subscription_id.
Ids of the Stripe objects on your connected account — join
keys into your own Stripe Dashboard/API. Manage a
subscription’s post-checkout lifecycle with subscription_id.
EventType PaymentCanceledWebhookEventEventType
type PaymentDeclinedWebhookEvent struct{…}
Data PaymentDeclinedWebhookEventDataThe payment request, as returned by
GET /v3/payment_requests/{paymentRequestId}.
The payment request, as returned by
GET /v3/payment_requests/{paymentRequestId}.
What was charged at checkout, in the currency’s minor
units. In subscription mode this is the first invoice’s
total — all items after any discounts are applied.
Status string
Discount PaymentDeclinedWebhookEventDataDiscountOptionalSubscription mode — the discount Stripe applied, read back
from the coupon. Absent when none was applied.
Subscription mode — the discount Stripe applied, read back from the coupon. Absent when none was applied.
Interval stringOptionalSubscription mode — how often the subscription renews.
Subscription mode — how often the subscription renews.
Natural PaymentDeclinedWebhookEventDataNaturalOptionalNatural-rail join keys, present when rail: natural.
Natural-rail join keys, present when rail: natural.
Stripe PaymentDeclinedWebhookEventDataStripeOptionalIds of the Stripe objects on your connected account — join
keys into your own Stripe Dashboard/API. Manage a
subscription’s post-checkout lifecycle with subscription_id.
Ids of the Stripe objects on your connected account — join
keys into your own Stripe Dashboard/API. Manage a
subscription’s post-checkout lifecycle with subscription_id.
EventType PaymentDeclinedWebhookEventEventType
type PaymentExpiredWebhookEvent struct{…}
Data PaymentExpiredWebhookEventDataThe payment request, as returned by
GET /v3/payment_requests/{paymentRequestId}.
The payment request, as returned by
GET /v3/payment_requests/{paymentRequestId}.
What was charged at checkout, in the currency’s minor
units. In subscription mode this is the first invoice’s
total — all items after any discounts are applied.
Status string
Discount PaymentExpiredWebhookEventDataDiscountOptionalSubscription mode — the discount Stripe applied, read back
from the coupon. Absent when none was applied.
Subscription mode — the discount Stripe applied, read back from the coupon. Absent when none was applied.
Natural PaymentExpiredWebhookEventDataNaturalOptionalNatural-rail join keys, present when rail: natural.
Natural-rail join keys, present when rail: natural.
Stripe PaymentExpiredWebhookEventDataStripeOptionalIds of the Stripe objects on your connected account — join
keys into your own Stripe Dashboard/API. Manage a
subscription’s post-checkout lifecycle with subscription_id.
Ids of the Stripe objects on your connected account — join
keys into your own Stripe Dashboard/API. Manage a
subscription’s post-checkout lifecycle with subscription_id.
EventType PaymentExpiredWebhookEventEventType
type PaymentSucceededWebhookEvent struct{…}
Data PaymentSucceededWebhookEventDataThe payment request, as returned by
GET /v3/payment_requests/{paymentRequestId}.
The payment request, as returned by
GET /v3/payment_requests/{paymentRequestId}.
What was charged at checkout, in the currency’s minor
units. In subscription mode this is the first invoice’s
total — all items after any discounts are applied.
Status string
Discount PaymentSucceededWebhookEventDataDiscountOptionalSubscription mode — the discount Stripe applied, read back
from the coupon. Absent when none was applied.
Subscription mode — the discount Stripe applied, read back from the coupon. Absent when none was applied.
Interval stringOptionalSubscription mode — how often the subscription renews.
Subscription mode — how often the subscription renews.
Natural PaymentSucceededWebhookEventDataNaturalOptionalNatural-rail join keys, present when rail: natural.
Natural-rail join keys, present when rail: natural.
Stripe PaymentSucceededWebhookEventDataStripeOptionalIds of the Stripe objects on your connected account — join
keys into your own Stripe Dashboard/API. Manage a
subscription’s post-checkout lifecycle with subscription_id.
Ids of the Stripe objects on your connected account — join
keys into your own Stripe Dashboard/API. Manage a
subscription’s post-checkout lifecycle with subscription_id.