> 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 # GetPaymentLinksSettings # Package: paymentLinks # Namespace: PaymentLinksSettingsService # Method link: https://dev.wix.com/docs/api-reference/business-management/get-paid/payment-links/payment-link-settings/get-payment-links-settings.md ## Permission Scopes: Manage Paylinks: SCOPE.PAYLINKS.MANAGE ## Introduction Retrieves the settings for a site’s payment links. --- ## REST API ### Schema ``` Method: getPaymentLinksSettings Description: Retrieves the settings for a site’s payment links. URL: https://www.wixapis.com/payment-links/v1/payment-links-settings Method: GET Return type: GetPaymentLinksSettingsResponse - 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`. ``` ### Examples ### Get Payment Links Settings ```curl curl -X GET \ 'https://www.wixapis.com/payment-links/v1/payment-links-settings' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.paymentLinks.PaymentLinksSettingsService.getPaymentLinksSettings() Description: Retrieves the settings for a site’s payment links. 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`. ``` ### Examples ### getPaymentLinksSettings ```javascript import { paymentLinksSettings } from '@wix/get-paid'; async function getPaymentLinksSettings() { const response = await paymentLinksSettings.getPaymentLinksSettings(); }; ``` ### getPaymentLinksSettings (with elevated permissions) ```javascript import { paymentLinksSettings } from '@wix/get-paid'; import { auth } from '@wix/essentials'; async function myGetPaymentLinksSettingsMethod() { const elevatedGetPaymentLinksSettings = auth.elevate(paymentLinksSettings.getPaymentLinksSettings); const response = await elevatedGetPaymentLinksSettings(); } ``` ### getPaymentLinksSettings (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 getPaymentLinksSettings() { const response = await myWixClient.paymentLinksSettings.getPaymentLinksSettings(); }; ``` ---