For AI agents and LLMs: a structured documentation index is available at /llms.txt. Every page has a Markdown sibling — append .md to any URL.

Skip to content
Paddle Docs home

Update checkout payment method settings

Updates the checkout payment method settings for your account.

PATCH/settings/checkout-payment-methods

Updates the checkout payment method settings for your account.

Send only the payment methods that you want to change. Payment methods that you omit keep their current value. Paddle sets available, so you can't update it.

Returns a checkout_payment_method_not_available error if you enable a payment method that isn't available on your account, and a checkout_payment_method_unknown error if the request includes a payment method that Paddle doesn't recognize.

If successful, your response includes a copy of the updated checkout payment method settings entity.

Requires checkout_settings.write permission.

Request body

payment_methodsobjectrequired
Settings to update for each payment method, keyed by payment method. Send only the payment methods that you want to change.
alipayobject
Settings to update for the Alipay payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout.
apple_payobject
Settings to update for the Apple Pay payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout.
bancontactobject
Settings to update for the Bancontact payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout.
blikobject
Settings to update for the BLIK payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout.
cardobject
Settings to update for the card payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout.
google_payobject
Settings to update for the Google Pay payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout.
idealobject
Settings to update for the iDEAL payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout.
kakao_payobject
Settings to update for the KakaoPay payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout.
mb_wayobject
Settings to update for the MB WAY payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout.
naver_payobject
Settings to update for the Naver Pay payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout.
paycoobject
Settings to update for the Payco payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout.
paypalobject
Settings to update for the PayPal payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout.
pixobject
Settings to update for the Pix payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout.
samsung_payobject
Settings to update for the Samsung Pay payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout.
south_korea_local_cardobject
Settings to update for the South Korea local card payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout.
upiobject
Settings to update for the UPI payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout.
wechat_payobject
Settings to update for the WeChat Pay payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout.

Response (200)

dataobjectrequired
Represents the checkout payment method settings for your account.
payment_methodsobjectrequired
Settings for each payment method available at checkout, keyed by payment method. Every supported payment method is always present.
alipayobjectrequired
Settings for the Alipay payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout. A payment method is offered at checkout only when enabled and available are both true. The stored preference is returned even while available is false.
availablebooleanrequired
Whether Paddle offers this payment method on your account. Set by Paddle.
apple_payobjectrequired
Settings for the Apple Pay payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout. A payment method is offered at checkout only when enabled and available are both true. The stored preference is returned even while available is false.
availablebooleanrequired
Whether Paddle offers this payment method on your account. Set by Paddle.
bancontactobjectrequired
Settings for the Bancontact payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout. A payment method is offered at checkout only when enabled and available are both true. The stored preference is returned even while available is false.
availablebooleanrequired
Whether Paddle offers this payment method on your account. Set by Paddle.
blikobjectrequired
Settings for the BLIK payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout. A payment method is offered at checkout only when enabled and available are both true. The stored preference is returned even while available is false.
availablebooleanrequired
Whether Paddle offers this payment method on your account. Set by Paddle.
cardobjectrequired
Settings for the card payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout. A payment method is offered at checkout only when enabled and available are both true. The stored preference is returned even while available is false.
availablebooleanrequired
Whether Paddle offers this payment method on your account. Set by Paddle.
google_payobjectrequired
Settings for the Google Pay payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout. A payment method is offered at checkout only when enabled and available are both true. The stored preference is returned even while available is false.
availablebooleanrequired
Whether Paddle offers this payment method on your account. Set by Paddle.
idealobjectrequired
Settings for the iDEAL payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout. A payment method is offered at checkout only when enabled and available are both true. The stored preference is returned even while available is false.
availablebooleanrequired
Whether Paddle offers this payment method on your account. Set by Paddle.
kakao_payobjectrequired
Settings for the KakaoPay payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout. A payment method is offered at checkout only when enabled and available are both true. The stored preference is returned even while available is false.
availablebooleanrequired
Whether Paddle offers this payment method on your account. Set by Paddle.
mb_wayobjectrequired
Settings for the MB WAY payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout. A payment method is offered at checkout only when enabled and available are both true. The stored preference is returned even while available is false.
availablebooleanrequired
Whether Paddle offers this payment method on your account. Set by Paddle.
naver_payobjectrequired
Settings for the Naver Pay payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout. A payment method is offered at checkout only when enabled and available are both true. The stored preference is returned even while available is false.
availablebooleanrequired
Whether Paddle offers this payment method on your account. Set by Paddle.
paycoobjectrequired
Settings for the Payco payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout. A payment method is offered at checkout only when enabled and available are both true. The stored preference is returned even while available is false.
availablebooleanrequired
Whether Paddle offers this payment method on your account. Set by Paddle.
paypalobjectrequired
Settings for the PayPal payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout. A payment method is offered at checkout only when enabled and available are both true. The stored preference is returned even while available is false.
availablebooleanrequired
Whether Paddle offers this payment method on your account. Set by Paddle.
pixobjectrequired
Settings for the Pix payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout. A payment method is offered at checkout only when enabled and available are both true. The stored preference is returned even while available is false.
availablebooleanrequired
Whether Paddle offers this payment method on your account. Set by Paddle.
samsung_payobjectrequired
Settings for the Samsung Pay payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout. A payment method is offered at checkout only when enabled and available are both true. The stored preference is returned even while available is false.
availablebooleanrequired
Whether Paddle offers this payment method on your account. Set by Paddle.
south_korea_local_cardobjectrequired
Settings for the South Korea local card payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout. A payment method is offered at checkout only when enabled and available are both true. The stored preference is returned even while available is false.
availablebooleanrequired
Whether Paddle offers this payment method on your account. Set by Paddle.
upiobjectrequired
Settings for the UPI payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout. A payment method is offered at checkout only when enabled and available are both true. The stored preference is returned even while available is false.
availablebooleanrequired
Whether Paddle offers this payment method on your account. Set by Paddle.
wechat_payobjectrequired
Settings for the WeChat Pay payment method.
enabledbooleanrequired
Whether this payment method is enabled for checkout. A payment method is offered at checkout only when enabled and available are both true. The stored preference is returned even while available is false.
availablebooleanrequired
Whether Paddle offers this payment method on your account. Set by Paddle.
metaobjectrequired
Information about this response.
request_idstringrequired
Example: b15ec92e-8688-40d4-a04d-f44cbec93355
Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.
Request
{
  "payment_methods": {
    "apple_pay": {
      "enabled": true
    },
    "alipay": {
      "enabled": false
    }
  }
}
Response
{
  "data": {
    "payment_methods": {
      "alipay": {
        "enabled": false,
        "available": true
      },
      "apple_pay": {
        "enabled": true,
        "available": true
      },
      "bancontact": {
        "enabled": false,
        "available": true
      },
      "blik": {
        "enabled": false,
        "available": false
      },
      "card": {
        "enabled": true,
        "available": true
      },
      "google_pay": {
        "enabled": true,
        "available": true
      },
      "ideal": {
        "enabled": false,
        "available": true
      },
      "kakao_pay": {
        "enabled": false,
        "available": false
      },
      "mb_way": {
        "enabled": false,
        "available": false
      },
      "naver_pay": {
        "enabled": false,
        "available": false
      },
      "payco": {
        "enabled": false,
        "available": false
      },
      "paypal": {
        "enabled": true,
        "available": true
      },
      "pix": {
        "enabled": false,
        "available": false
      },
      "samsung_pay": {
        "enabled": false,
        "available": false
      },
      "south_korea_local_card": {
        "enabled": false,
        "available": false
      },
      "upi": {
        "enabled": false,
        "available": false
      },
      "wechat_pay": {
        "enabled": false,
        "available": false
      }
    }
  },
  "meta": {
    "request_id": "45cbcb2f-6a71-4b09-8a05-4c9e11b10c11"
  }
}

Was this page helpful?