> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # UpdatePaymentLinksSettings # Package: paymentLinks # Namespace: PaymentLinksSettingsService # Method link: https://dev.wix.com/docs/api-reference/business-management/get-paid/payment-links/payment-link-settings/update-payment-links-settings.md ## Permission Scopes: Manage Paylinks: SCOPE.PAYLINKS.MANAGE ## Introduction Updates the settings for a site’s payment links. --- ## REST API ### Schema ``` Method: updatePaymentLinksSettings Description: Updates the settings for a site’s payment links. URL: https://www.wixapis.com/payment-links/v1/payment-links-settings Method: PATCH # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: paymentLinksSettings, paymentLinksSettings.revision Method parameters: param name: fieldMask | type: fieldMask | description: List of fields to update. param name: paymentLinksSettings | type: PaymentLinksSettings | required: true - name: revision | type: string | description: Revision number, which increments by 1 each time the payment link settings are updated. | required: true - name: policyAgreementCheckboxDisabled | type: boolean | description: Whether the store policy agreement checkbox in the checkout page is disabled. Default: `false`. - name: continueShoppingButtonDisabled | type: boolean | description: Whether the continue shopping button in the checkout page is disabled. Default: `false`. Return type: UpdatePaymentLinksSettingsResponse - name: paymentLinksSettings | type: PaymentLinksSettings | description: Payment link settings. - name: revision | type: string | description: Revision number, which increments by 1 each time the payment link settings are updated. - name: policyAgreementCheckboxDisabled | type: boolean | description: Whether the store policy agreement checkbox in the checkout page is disabled. Default: `false`. - name: continueShoppingButtonDisabled | type: boolean | description: Whether the continue shopping button in the checkout page is disabled. Default: `false`. Possible Errors: HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: EMPTY_PAYMENT_LINKS_SETTINGS | Description: No payment link settings were specified. ``` ### Examples ### Update Payment Links Settings Updates Payment Links Settings ```curl curl -X PATCH \ 'https://www.wixapis.com/payment-links/v1/payment-links-settings' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' \ --data-binary '{ "paymentLinksSettings": { "policyAgreementCheckboxDisabled": true, "continueShoppingButtonDisabled": true }, "fieldMask": { "paths": [ "policyAgreementCheckboxDisabled", "continueShoppingButtonDisabled" ] } }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.paymentLinks.PaymentLinksSettingsService.updatePaymentLinksSettings(paymentLinksSettings, options) Description: Updates the settings for a site’s payment links. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: paymentLinksSettings, paymentLinksSettings.revision Method parameters: param name: options | type: UpdatePaymentLinksSettingsOptions none - name: fieldMask | type: array | description: List of fields to update. param name: paymentLinksSettings | type: PaymentLinksSettings | required: true - name: revision | type: string | description: Revision number, which increments by 1 each time the payment link settings are updated. | required: true - name: policyAgreementCheckboxDisabled | type: boolean | description: Whether the store policy agreement checkbox in the checkout page is disabled. Default: `false`. - name: continueShoppingButtonDisabled | type: boolean | description: Whether the continue shopping button in the checkout page is disabled. Default: `false`. Return type: PROMISE - name: paymentLinksSettings | type: PaymentLinksSettings | description: Payment link settings. - name: revision | type: string | description: Revision number, which increments by 1 each time the payment link settings are updated. - name: policyAgreementCheckboxDisabled | type: boolean | description: Whether the store policy agreement checkbox in the checkout page is disabled. Default: `false`. - name: continueShoppingButtonDisabled | type: boolean | description: Whether the continue shopping button in the checkout page is disabled. Default: `false`. Possible Errors: HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: EMPTY_PAYMENT_LINKS_SETTINGS | Description: No payment link settings were specified. ``` ### Examples ### updatePaymentLinksSettings ```javascript import { paymentLinksSettings } from '@wix/get-paid'; async function updatePaymentLinksSettings(paymentLinksSettings,options) { const response = await paymentLinksSettings.updatePaymentLinksSettings(paymentLinksSettings,options); }; ``` ### updatePaymentLinksSettings (with elevated permissions) ```javascript import { paymentLinksSettings } from '@wix/get-paid'; import { auth } from '@wix/essentials'; async function myUpdatePaymentLinksSettingsMethod(paymentLinksSettings,options) { const elevatedUpdatePaymentLinksSettings = auth.elevate(paymentLinksSettings.updatePaymentLinksSettings); const response = await elevatedUpdatePaymentLinksSettings(paymentLinksSettings,options); } ``` ### updatePaymentLinksSettings (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { paymentLinksSettings } from '@wix/get-paid'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { paymentLinksSettings }, // Include the auth strategy and host as relevant }); async function updatePaymentLinksSettings(paymentLinksSettings,options) { const response = await myWixClient.paymentLinksSettings.updatePaymentLinksSettings(paymentLinksSettings,options); }; ``` ---