Docs

payment_method.saved

Occurs when a payment method is saved.

Occurs when a payment method is saved for a customer. The origin field describes how it was saved:

  • saved_during_purchase — the customer chose to save their payment method while purchasing a one-time item.
  • subscription — the customer purchased a subscription, so their payment method was saved automatically for future renewals.
  • subscription_saved_during_purchase — the customer chose to save their payment method when purchasing a subscription.
event_idstringrequired
Example: evt_01gks14ge726w50ch2tmaw2a1x
Unique Paddle ID for this event, prefixed with evt_.
Pattern: ^evt_[a-z\d]{26}$
event_typestringrequired
Type of event sent by Paddle, in the format entity.event_type.
Values
+ Show all values
occurred_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this event occurred.
notification_idstringrequired
Example: ntf_01ghbkd0frb9k95cnhwd1bxpvk
Unique Paddle ID for this notification, prefixed with ntf_.
Pattern: ^ntf_[a-z\d]{26}$
dataobjectrequired
New or changed entity.
idstringrequired
Example: paymtd_01hmypstbdx6vgg6k98ntc6hz6
Unique Paddle ID for the payment method, prefixed with paymtd_
Pattern: ^paymtd_[a-z\d]{26}$
customer_idstringrequired
Example: ctm_01gj3jd0a9mwvt5t6zszvrjx5n
Unique Paddle ID for the customer, prefixed with ctm_
Pattern: ^ctm_[a-z\d]{26}$
address_idstringrequired
Example: add_01gv32pw30ctm9ycm5xykn20kk
Unique Paddle ID for the address, prefixed with add_
Pattern: ^add_[a-z\d]{26}$
typestringrequired
Type of payment method saved.
Values
  • alipay
    Alipay, popular in China.
  • apple_pay
    Apple Pay on a supported Apple device.
  • blik
    BLIK, a popular payment method in Poland.
  • card
    Credit or debit card.
  • google_pay
    Google Pay on a supported Android device, Chromebook, or Google Chrome browser.
+ Show all values
  • kakao_pay
    Kakao Pay, a popular payment method in South Korea.
  • korea_local
    Korean payment methods, which includes over 20 payment options for the Korean market. Check underlying_payment_method.korea_local for information about the Korean payment method used to pay.
  • south_korea_local_card
    Korean local credit or debit card.
  • mb_way
    MB WAY, a popular payment method in Portugal.
  • naver_pay
    Naver Pay, a popular payment method in South Korea.
  • payco
    Payco, a popular payment method in South Korea.
  • paypal
    PayPal.
  • pix
    Pix, popular in Brazil.
  • samsung_pay
    Samsung Pay, a popular payment method in South Korea.
  • upi
    Unified Payments Interface (UPI), popular in India.
  • wechat_pay
    WeChat Pay, a popular payment method in China.
originstringrequired
Describes how this payment method was saved.
Values
  • saved_during_purchase
    The customer chose to save this payment method while purchasing a one-time item.
  • subscription
    The customer purchased a subscription, so this payment method was saved for future purchases.
  • subscription_saved_during_purchase
    The customer chose to save the payment method when purchasing a subscription.
saved_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this entity was saved. Set automatically by Paddle.
updated_atstring (date-time)required
Example: 2024-10-13T07:20:50.52Z
RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
payment_method.saved
{
  "event_id": "evt_01hwvkmsge7bhq1a31s35784zt",
  "event_type": "payment_method.saved",
  "occurred_at": "2024-05-02T02:55:25.198953Z",
  "notification_id": "ntf_01hwvkmsknrgqw4z1598qw4ypt",
  "data": {
    "id": "paymtd_01hs8zx6x377xfsfrt2bqsevbw",
    "customer_id": "ctm_01hv6y1jedq4p1n0yqn5ba3ky4",
    "address_id": "add_01hv8gq3318ktkfengj2r75gfx",
    "type": "card",
    "origin": "saved_during_purchase",
    "saved_at": "2024-05-02T02:55:25.198953Z",
    "updated_at": "2024-05-02T02:55:25.198953Z"
  }
}

Was this page helpful?