Webhooks
ModelsExpand Collapse
class ConnectionCreatedWebhookEvent: …
data: DataThe 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.
discount: Optional[DataDiscount]Subscription 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: Optional[Literal["day", "week", "month", "year"]]Subscription mode — how often the subscription renews.
Subscription mode — how often the subscription renews.
mode: Optional[Literal["payment", "subscription"]]Whether the request collected a one-time charge or started a subscription.
Whether the request collected a one-time charge or started a subscription.
stripe: Optional[DataStripe]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.
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.
class ConnectionRevokedWebhookEvent: …
data: DataThe 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.
discount: Optional[DataDiscount]Subscription 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: Optional[Literal["day", "week", "month", "year"]]Subscription mode — how often the subscription renews.
Subscription mode — how often the subscription renews.
mode: Optional[Literal["payment", "subscription"]]Whether the request collected a one-time charge or started a subscription.
Whether the request collected a one-time charge or started a subscription.
stripe: Optional[DataStripe]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.
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.
class PaymentAuthorizedWebhookEvent: …
data: DataThe 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.
discount: Optional[DataDiscount]Subscription 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: Optional[Literal["day", "week", "month", "year"]]Subscription mode — how often the subscription renews.
Subscription mode — how often the subscription renews.
mode: Optional[Literal["payment", "subscription"]]Whether the request collected a one-time charge or started a subscription.
Whether the request collected a one-time charge or started a subscription.
stripe: Optional[DataStripe]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.
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.
class PaymentCanceledWebhookEvent: …
data: DataThe 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.
discount: Optional[DataDiscount]Subscription 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: Optional[Literal["day", "week", "month", "year"]]Subscription mode — how often the subscription renews.
Subscription mode — how often the subscription renews.
mode: Optional[Literal["payment", "subscription"]]Whether the request collected a one-time charge or started a subscription.
Whether the request collected a one-time charge or started a subscription.
stripe: Optional[DataStripe]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.
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.
class PaymentDeclinedWebhookEvent: …
data: DataThe 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.
discount: Optional[DataDiscount]Subscription 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: Optional[Literal["day", "week", "month", "year"]]Subscription mode — how often the subscription renews.
Subscription mode — how often the subscription renews.
mode: Optional[Literal["payment", "subscription"]]Whether the request collected a one-time charge or started a subscription.
Whether the request collected a one-time charge or started a subscription.
stripe: Optional[DataStripe]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.
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.
class PaymentExpiredWebhookEvent: …
data: DataThe 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.
discount: Optional[DataDiscount]Subscription 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: Optional[Literal["day", "week", "month", "year"]]Subscription mode — how often the subscription renews.
Subscription mode — how often the subscription renews.
mode: Optional[Literal["payment", "subscription"]]Whether the request collected a one-time charge or started a subscription.
Whether the request collected a one-time charge or started a subscription.
stripe: Optional[DataStripe]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.
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.
class PaymentSucceededWebhookEvent: …
data: DataThe 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.
discount: Optional[DataDiscount]Subscription 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: Optional[Literal["day", "week", "month", "year"]]Subscription mode — how often the subscription renews.
Subscription mode — how often the subscription renews.
mode: Optional[Literal["payment", "subscription"]]Whether the request collected a one-time charge or started a subscription.
Whether the request collected a one-time charge or started a subscription.
stripe: Optional[DataStripe]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.
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.