<div class="doc-version" data-version="unstable"> <p>A request to hide a payment method during checkout.</p> <p>When your Function returns this operation, it removes the specified payment method from the available options shown to customers during checkout.</p> <p>Use this operation when you want to conditionally hide payment methods based on checkout attributes, customer data, or other business logic implemented in your Function.</p> <h2 id="input-fields-unstable">Fields</h2> <ul class="fields-list"> <li> <div class="field"> <div class="field-name"> paymentMethodId (<a href="/api/functions/reference/payment-customization/graphql/scalar#id-unstable"><code>ID!</code></a>) <span class="heading-flag">Required</span> </div> </div> <div> <p>The identifier of the payment method to hide out.</p> </div> </li> <li> <div class="field"> <div class="field-name"> placements (<a href="/api/functions/reference/payment-customization/graphql/common-objects/paymentcustomizationpaymentmethodplacement"><code>[PaymentCustomizationPaymentMethodPlacement!]</code></a>) </div> </div> <div> <p>Placement types to hide. If not provided, all placements will be hidden.</p> </div> </li> </ul> </div> <div class="doc-version doc-version--rc" data-version="2025-07"> <p>A request to hide a payment method during checkout.</p> <p>When your Function returns this operation, it removes the specified payment method from the available options shown to customers during checkout.</p> <p>Use this operation when you want to conditionally hide payment methods based on checkout attributes, customer data, or other business logic implemented in your Function.</p> <h2 id="input-fields-2025-07">Fields</h2> <ul class="fields-list"> <li> <div class="field"> <div class="field-name"> paymentMethodId (<a href="/api/functions/reference/payment-customization/graphql/scalar#id-2025-07"><code>ID!</code></a>) <span class="heading-flag">Required</span> </div> </div> <div> <p>The identifier of the payment method to hide out.</p> </div> </li> <li> <div class="field"> <div class="field-name"> placements (<a href="/api/functions/reference/payment-customization/graphql/common-objects/paymentcustomizationpaymentmethodplacement"><code>[PaymentCustomizationPaymentMethodPlacement!]</code></a>) </div> </div> <div> <p>Placement types to hide. If not provided, all placements will be hidden.</p> </div> </li> </ul> </div> <div class="doc-version doc-version--latest selected" data-version="2025-04"> <p>A request to hide a payment method during checkout.</p> <p>When your Function returns this operation, it removes the specified payment method from the available options shown to customers during checkout.</p> <p>Use this operation when you want to conditionally hide payment methods based on checkout attributes, customer data, or other business logic implemented in your Function.</p> <h2 id="input-fields-2025-04">Fields</h2> <ul class="fields-list"> <li> <div class="field"> <div class="field-name"> paymentMethodId (<a href="/api/functions/reference/payment-customization/graphql/scalar#id-2025-04"><code>ID!</code></a>) <span class="heading-flag">Required</span> </div> </div> <div> <p>The identifier of the payment method to hide out.</p> </div> </li> <li> <div class="field"> <div class="field-name"> placements (<a href="/api/functions/reference/payment-customization/graphql/common-objects/paymentcustomizationpaymentmethodplacement"><code>[PaymentCustomizationPaymentMethodPlacement!]</code></a>) </div> </div> <div> <p>Placement types to hide. If not provided, all placements will be hidden.</p> </div> </li> </ul> </div> <div class="doc-version" data-version="2025-01"> <p>A request to hide a payment method during checkout.</p> <p>When your Function returns this operation, it removes the specified payment method from the available options shown to customers during checkout.</p> <p>Use this operation when you want to conditionally hide payment methods based on checkout attributes, customer data, or other business logic implemented in your Function.</p> <h2 id="input-fields-2025-01">Fields</h2> <ul class="fields-list"> <li> <div class="field"> <div class="field-name"> paymentMethodId (<a href="/api/functions/reference/payment-customization/graphql/scalar#id-2025-01"><code>ID!</code></a>) <span class="heading-flag">Required</span> </div> </div> <div> <p>The identifier of the payment method to hide out.</p> </div> </li> <li> <div class="field"> <div class="field-name"> placements (<a href="/api/functions/reference/payment-customization/graphql/common-objects/paymentcustomizationpaymentmethodplacement"><code>[PaymentCustomizationPaymentMethodPlacement!]</code></a>) </div> </div> <div> <p>Placement types to hide. If not provided, all placements will be hidden.</p> </div> </li> </ul> </div> <div class="doc-version" data-version="2024-10"> <p>A request to hide a payment method during checkout.</p> <p>When your Function returns this operation, it removes the specified payment method from the available options shown to customers during checkout.</p> <p>Use this operation when you want to conditionally hide payment methods based on checkout attributes, customer data, or other business logic implemented in your Function.</p> <h2 id="input-fields-2024-10">Fields</h2> <ul class="fields-list"> <li> <div class="field"> <div class="field-name"> paymentMethodId (<a href="/api/functions/reference/payment-customization/graphql/scalar#id-2024-10"><code>ID!</code></a>) <span class="heading-flag">Required</span> </div> </div> <div> <p>The identifier of the payment method to hide out.</p> </div> </li> <li> <div class="field"> <div class="field-name"> placements (<a href="/api/functions/reference/payment-customization/graphql/common-objects/paymentcustomizationpaymentmethodplacement"><code>[PaymentCustomizationPaymentMethodPlacement!]</code></a>) </div> </div> <div> <p>Placement types to hide. If not provided, all placements will be hidden.</p> </div> </li> </ul> </div> <div class="doc-version" data-version="2024-07"> <p>A request to hide a payment method during checkout.</p> <p>When your Function returns this operation, it removes the specified payment method from the available options shown to customers during checkout.</p> <p>Use this operation when you want to conditionally hide payment methods based on checkout attributes, customer data, or other business logic implemented in your Function.</p> <h2 id="input-fields-2024-07">Fields</h2> <ul class="fields-list"> <li> <div class="field"> <div class="field-name"> paymentMethodId (<a href="/api/functions/reference/payment-customization/graphql/scalar#id-2024-07"><code>ID!</code></a>) <span class="heading-flag">Required</span> </div> </div> <div> <p>The identifier of the payment method to hide out.</p> </div> </li> <li> <div class="field"> <div class="field-name"> placements (<a href="/api/functions/reference/payment-customization/graphql/common-objects/paymentcustomizationpaymentmethodplacement"><code>[PaymentCustomizationPaymentMethodPlacement!]</code></a>) </div> </div> <div> <p>Placement types to hide. If not provided, all placements will be hidden.</p> </div> </li> </ul> </div> <div class="doc-version" data-version="2024-04"> <p>A request to hide a payment method during checkout.</p> <p>When your Function returns this operation, it removes the specified payment method from the available options shown to customers during checkout.</p> <p>Use this operation when you want to conditionally hide payment methods based on checkout attributes, customer data, or other business logic implemented in your Function.</p> <h2 id="input-fields-2024-04">Fields</h2> <ul class="fields-list"> <li> <div class="field"> <div class="field-name"> paymentMethodId (<a href="/api/functions/reference/payment-customization/graphql/scalar#id-2024-04"><code>ID!</code></a>) <span class="heading-flag">Required</span> </div> </div> <div> <p>The identifier of the payment method to hide out.</p> </div> </li> </ul> </div>