> 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

# Package: pricingPlans

# Namespace: pricingPlansSettings

# Webhook link: https://dev.wix.com/docs/api-reference/business-solutions/pricing-plans/pricing-plans-settings/pricing-plans-settings-created.md

# Webhook Permissions Scopes IDs:
Read Orders: SCOPE.DC-PAIDPLANS.READ-ORDERS

## Introduction

Triggered when a site's Pricing Plans settings are created, which happens when the Wix Pricing Plans app is installed on the site.

---

## REST API

### Schema

```
Webhook: Pricing Plans Settings Created
Description: Triggered when a site's Pricing Plans settings are created, which happens when the Wix Pricing Plans app is installed on the site.
Event body:
 - name: id | type: string | description: Unique event ID. Allows clients to ignore duplicate events.
 - name: entityFqdn | type: string | description: Fully qualified domain name of the entity associated with the event.
 - name: slug | type: string | description: Event name.
 - name: entityId | type: string | description: ID of the entity associated with the event.
 - name: eventTime | type: string (date-time) | description: Event timestamp.
 - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application such as GDPR.
 - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event.
 - name: createdEvent | type: object | description: Created event details.
    - name: entity | type: PricingPlansSettings | description: The created entity.
        - 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.
        - 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.
        - name: updatedDate | type: string | description: Date and time the site's Pricing Plans settings were last updated.
        - 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).
        - 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


```curl
{
  "id": "3c7d41a8-90f2-4b16-8e5d-6b2c9f3a7d40",
  "entityFqdn": "wix.pricing_plans.settings.v1.pricing_plans_settings",
  "slug": "created",
  "entityId": "a4f2c8d1-53be-4e07-9c6a-18db7f405e92",
  "createdEvent": {
    "entity": {
      "revision": "1",
      "createdDate": "2026-01-13T20:28:56.138Z",
      "updatedDate": "2026-01-13T20:28:56.138Z",
      "taxableAddress": "BILLING",
      "guestCheckoutSettings": {
        "enabled": false
      },
      "invoiceSettings": {
        "sendInvoiceOnPayment": false
      },
      "extendedFields": {
        "namespaces": {}
      }
    }
  },
  "eventTime": "2026-01-13T20:28:56.201Z",
  "triggeredByAnonymizeRequest": false
}

```

---

## JavaScript SDK

### Schema

```
Webhook: onPricingPlansSettingsCreated
Description: Triggered when a site's Pricing Plans settings are created, which happens when the Wix Pricing Plans app is installed on the site.
Payload: PricingPlansSettingsCreatedEnvelope
  - name: entity | type: PricingPlansSettings | description: none
     - 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.
     - 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.
     - name: _updatedDate | type: Date | description: Date and time the site's Pricing Plans settings were last updated.
     - 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).
     - 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`.
  - name: metadata | type: EventMetadata | description: none
     - name: instanceId | type: string | description: App instance GUID.
     - name: eventType | type: string | description: Event type.
     - name: identity | type: IdentificationData | description: The identification type and identity data.
        - ONE-OF:
           - name: anonymousVisitorId | type: string | description: GUID of a site visitor that has not logged in to the site.
           - name: memberId | type: string | description: GUID of a site visitor that has logged in to the site.
           - name: wixUserId | type: string | description: GUID of a Wix user (site owner, contributor, etc.).
           - name: appId | type: string | description: GUID of an app.
        - name: identityType | type: WebhookIdentityType | description: 
             - enum: UNKNOWN, ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
     - name: accountInfo | type: AccountInfo | description: Details related to the account
        - name: accountId | type: string | description: GUID of the Wix account associated with the event.
        - name: parentAccountId | type: string | description: GUID of the parent Wix account. Only included when accountId belongs to a child account.
        - name: siteId | type: string | description: GUID of the Wix site associated with the event. Only included when the event is tied to a specific site.
     - name: _id | type: string | description: Event GUID. With this GUID you can easily spot duplicated events and ignore them.
     - name: entityFqdn | type: string | description: Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities. For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
     - name: slug | type: string | description: Event action name, placed at the top level to make it easier for users to dispatch messages. For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
     - name: entityId | type: string | description: GUID of the entity associated with the event.
     - name: eventTime | type: Date | description: Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`.
     - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
     - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event.
     - name: entityEventSequence | type: string | description: A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number. You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.

```

### Examples


```javascript
import { pricingPlansSettings } from '@wix/pricing-plans';

pricingPlansSettings.onPricingPlansSettingsCreated((event) => {
    // handle your event here
});
```


```javascript
import { createClient, AppStrategy } from '@wix/sdk';
import { pricingPlansSettings } from '@wix/pricing-plans';

const wixClient = createClient({
  auth: AppStrategy({
    appId: 'MY-APP-ID',
    publicKey: 'YOUR_APP_PUBLIC_KEY',
  }),
  modules: {
      pricingPlansSettings,
    },
});

wixClient.pricingPlansSettings.onPricingPlansSettingsCreated((event) => {
    // handle your event here
});
```

---