> 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 # GetPricingPlansSettings # Package: pricingPlans # Namespace: PricingPlansSettingsService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/pricing-plans/pricing-plans-settings/get-pricing-plans-settings.md ## Permission Scopes: Read Orders: SCOPE.DC-PAIDPLANS.READ-ORDERS ## Introduction Retrieves a site's Pricing Plans settings. A site whose settings were never created receives the default settings instead: `taxableAddress` is `BILLING`, `guestCheckoutSettings.enabled` is `false`, and `invoiceSettings.sendInvoiceOnPayment` is `false`. Default settings are returned without being stored, so a subsequent call to [Update Pricing Plans Settings](https://dev.wix.com/docs/api-reference/business-solutions/pricing-plans/pricing-plans-settings/update-pricing-plans-settings.md) that passes the returned `revision` can fail. --- ## REST API ### Schema ``` Method: getPricingPlansSettings Description: Retrieves a site's Pricing Plans settings. A site whose settings were never created receives the default settings instead: `taxableAddress` is `BILLING`, `guestCheckoutSettings.enabled` is `false`, and `invoiceSettings.sendInvoiceOnPayment` is `false`. Default settings are returned without being stored, so a subsequent call to [Update Pricing Plans Settings](https://dev.wix.com/docs/api-reference/business-solutions/pricing-plans/pricing-plans-settings/update-pricing-plans-settings.md) that passes the returned `revision` can fail. URL: https://www.wixapis.com/pricing-plans/settings/v1/pricing-plans-settings Method: GET Return type: GetPricingPlansSettingsResponse - name: pricingPlansSettings | type: PricingPlansSettings | description: Retrieved Pricing Plans settings. - name: revision | type: string | description: Revision number, which increments by 1 each time the Pricing Plans settings are updated. To prevent conflicting changes, the current revision must be passed when updating the Pricing Plans settings. | read-only: true | validation: format int64 - name: createdDate | type: string | description: Date and time the site's Pricing Plans settings were created, which happens when the Wix Pricing Plans app is installed on the site. For a site whose settings were never created, this is the date and time of the current read. | read-only: true | validation: format date-time - name: updatedDate | type: string | description: Date and time the site's Pricing Plans settings were last updated. | read-only: true | validation: format date-time - name: taxableAddress | type: TaxableAddress | description: Which of the site's addresses determines how tax is calculated for pricing plan purchases. Applies to every plan on the site. If set to `BUSINESS` and the site has no business address configured, plan purchases fail until an address is added to the site's [business info](https://dev.wix.com/docs/rest/business-management/site-properties/introduction.md). Default: `BILLING`. - enum: - BILLING: Tax is calculated from the buyer's billing address, which the buyer supplies at checkout. - BUSINESS: Tax is calculated from the site owner's business address, which is configured in the site's [business info](https://dev.wix.com/docs/rest/business-management/site-properties/introduction.md). - name: extendedFields | type: ExtendedFields | description: Custom field data for the Pricing Plans settings object. [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). | validation: format map - name: guestCheckoutSettings | type: GuestCheckoutSettings | description: Guest checkout settings, which control whether site visitors can buy a pricing plan without signing in as a site member. - name: enabled | type: boolean | description: Whether site visitors can purchase a pricing plan without signing in as a site member. Applies to every plan on the site. When `false`, a visitor who selects any plan must sign in as a site member before they can complete the purchase. Default: `false`. - name: invoiceSettings | type: InvoiceSettings | description: Invoice settings, which control whether buyers automatically receive an invoice after paying for a pricing plan online. - name: sendInvoiceOnPayment | type: boolean | description: Whether an invoice is automatically created and sent to the buyer each time an online payment for a pricing plan succeeds. Applies only to subscriptions that weren't purchased with the eCommerce APIs. Default: `false`. ``` ### Examples ### Get Pricing Plans Settings Retrieves the site's Pricing Plans settings. ```curl curl -X GET \ 'https://www.wixapis.com/pricing-plans/settings/v1/pricing-plans-settings' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.pricingPlans.pricingPlansSettings.getPricingPlansSettings() Description: Retrieves a site's Pricing Plans settings. A site whose settings were never created receives the default settings instead: `taxableAddress` is `BILLING`, `guestCheckoutSettings.enabled` is `false`, and `invoiceSettings.sendInvoiceOnPayment` is `false`. Default settings are returned without being stored, so a subsequent call to [Update Pricing Plans Settings](https://dev.wix.com/docs/api-reference/business-solutions/pricing-plans/pricing-plans-settings/update-pricing-plans-settings.md) that passes the returned `revision` can fail. Return type: PROMISE - name: revision | type: string | description: Revision number, which increments by 1 each time the Pricing Plans settings are updated. To prevent conflicting changes, the current revision must be passed when updating the Pricing Plans settings. | read-only: true | validation: format int64 - name: _createdDate | type: Date | description: Date and time the site's Pricing Plans settings were created, which happens when the Wix Pricing Plans app is installed on the site. For a site whose settings were never created, this is the date and time of the current read. | read-only: true - name: _updatedDate | type: Date | description: Date and time the site's Pricing Plans settings were last updated. | read-only: true - name: taxableAddress | type: TaxableAddress | description: Which of the site's addresses determines how tax is calculated for pricing plan purchases. Applies to every plan on the site. If set to `BUSINESS` and the site has no business address configured, plan purchases fail until an address is added to the site's [business info](https://dev.wix.com/docs/rest/business-management/site-properties/introduction.md). Default: `BILLING`. - enum: - BILLING: Tax is calculated from the buyer's billing address, which the buyer supplies at checkout. - BUSINESS: Tax is calculated from the site owner's business address, which is configured in the site's [business info](https://dev.wix.com/docs/rest/business-management/site-properties/introduction.md). - name: extendedFields | type: ExtendedFields | description: Custom field data for the Pricing Plans settings object. [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). | validation: format map - name: guestCheckoutSettings | type: GuestCheckoutSettings | description: Guest checkout settings, which control whether site visitors can buy a pricing plan without signing in as a site member. - name: enabled | type: boolean | description: Whether site visitors can purchase a pricing plan without signing in as a site member. Applies to every plan on the site. When `false`, a visitor who selects any plan must sign in as a site member before they can complete the purchase. Default: `false`. - name: invoiceSettings | type: InvoiceSettings | description: Invoice settings, which control whether buyers automatically receive an invoice after paying for a pricing plan online. - name: sendInvoiceOnPayment | type: boolean | description: Whether an invoice is automatically created and sent to the buyer each time an online payment for a pricing plan succeeds. Applies only to subscriptions that weren't purchased with the eCommerce APIs. Default: `false`. ``` ### Examples ### Get Pricing Plans Settings Retrieves the site's Pricing Plans settings. ```javascript import { pricingPlansSettings } from "@wix/pricing-plans"; async function getPricingPlansSettings() { const response = await pricingPlansSettings.getPricingPlansSettings(); return response; } /* Promise resolves to: * { * "revision": "6", * "_createdDate": "2026-01-13T20:28:56.138Z", * "_updatedDate": "2026-09-16T14:06:43.239Z", * "taxableAddress": "BUSINESS", * "guestCheckoutSettings": { * "enabled": true * }, * "invoiceSettings": { * "sendInvoiceOnPayment": true * } * } */ ``` ### getPricingPlansSettings (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 { pricingPlansSettings } from '@wix/pricing-plans'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { pricingPlansSettings }, // Include the auth strategy and host as relevant }); async function getPricingPlansSettings() { const response = await myWixClient.pricingPlansSettings.getPricingPlansSettings(); }; ``` ---