Migration Rest Portal

Build Apps

Go Headless

Client

API Preview

Develop Websites

REST

GraphQL (Alpha)

productId

string

Pass `true` to offer product by subscription and as one-time purchase. Pass `false` to offer product as subscription only.

allowed

boolean

Allow for one-time purchase of a product.
By default, product can be sold only as part of a subscription, not as a one-time purchase.
<blockquote class='warning'>

__Deprecation Notice:__

This endpoint has been deprecated and will be removed on January 29, 2024.

</blockquote>

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { subscriptionOptions } from '@wix/stores';

const wixClient = createClient({
  modules: { subscriptionOptions },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function allowOneTimePurchases(productId, allowed) {
  const response = await wixClient.subscriptionOptions.allowOneTimePurchases(productId, allowed);
}

allowOneTimePurchases() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { subscriptionOptions } from '@wix/stores';

const wixClient = createClient({
  modules: { subscriptionOptions },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

async function allowOneTimePurchases(productId, allowed) {
  const response = await wixClient.subscriptionOptions.allowOneTimePurchases(productId, allowed);
}

allowOneTimePurchases() with Dashboard app access

allowOneTimePurchases

void

options

AssignSubscriptionOptionsToProductOptions

Assign up to 6 subscription options to a specified product.
Pass an empty array to remove all subscription options assigned to a product.
<blockquote class='warning'>

__Deprecation Notice:__

This endpoint has been deprecated and will be removed on January 29, 2024.

</blockquote>

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { subscriptionOptions } from '@wix/stores';

const wixClient = createClient({
  modules: { subscriptionOptions },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function assignSubscriptionOptionsToProduct(productId, options) {
  const response = await wixClient.subscriptionOptions.assignSubscriptionOptionsToProduct(productId, options);
}

assignSubscriptionOptionsToProduct() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { subscriptionOptions } from '@wix/stores';

const wixClient = createClient({
  modules: { subscriptionOptions },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

async function assignSubscriptionOptionsToProduct(productId, options) {
  const response = await wixClient.subscriptionOptions.assignSubscriptionOptionsToProduct(productId, options);
}

assignSubscriptionOptionsToProduct() with Dashboard app access

assignSubscriptionOptionsToProduct

subscriptionOptions

Creates multiple subscription options (up to 100).
To assign to a product, call [`assignSubscriptionOptionsToProduct()`](https://www.wix.com/velo/reference/wix-stores-v2/subscriptionoptions/assign-subscription-options-to-product).
Subscription options that are not assigned to a product will not be visible in the Wix business manager.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { subscriptionOptions } from '@wix/stores';

const wixClient = createClient({
  modules: { subscriptionOptions },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function bulkCreateSubscriptionOptions(subscriptionOptions) {
  const response = await wixClient.subscriptionOptions.bulkCreateSubscriptionOptions(subscriptionOptions);
}

bulkCreateSubscriptionOptions() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { subscriptionOptions } from '@wix/stores';

const wixClient = createClient({
  modules: { subscriptionOptions },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

async function bulkCreateSubscriptionOptions(subscriptionOptions) {
  const response = await wixClient.subscriptionOptions.bulkCreateSubscriptionOptions(subscriptionOptions);
}

bulkCreateSubscriptionOptions() with Dashboard app access

bulkCreateSubscriptionOptions

BulkCreateSubscriptionOptionsResponse

IDs of the subscription options to delete.

Deletes multiple subscription options.
<blockquote class='warning'>

__Deprecation Notice:__

This endpoint has been deprecated and will be removed on January 29, 2024.

</blockquote>

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { subscriptionOptions } from '@wix/stores';

const wixClient = createClient({
  modules: { subscriptionOptions },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function bulkDeleteSubscriptionOptions(ids) {
  const response = await wixClient.subscriptionOptions.bulkDeleteSubscriptionOptions(ids);
}

bulkDeleteSubscriptionOptions() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { subscriptionOptions } from '@wix/stores';

const wixClient = createClient({
  modules: { subscriptionOptions },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

async function bulkDeleteSubscriptionOptions(ids) {
  const response = await wixClient.subscriptionOptions.bulkDeleteSubscriptionOptions(ids);
}

bulkDeleteSubscriptionOptions() with Dashboard app access

bulkDeleteSubscriptionOptions

Subscription options info. Only the passed parameters in each subscription option will be updated.

Updates multiple subscription options.
Only parameters passed will be updated.
<blockquote class='warning'>

__Deprecation Notice:__

This endpoint has been deprecated and will be removed on January 29, 2024.

</blockquote>

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { subscriptionOptions } from '@wix/stores';

const wixClient = createClient({
  modules: { subscriptionOptions },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function bulkUpdateSubscriptionOptions(subscriptionOptions) {
  const response = await wixClient.subscriptionOptions.bulkUpdateSubscriptionOptions(subscriptionOptions);
}

bulkUpdateSubscriptionOptions() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { subscriptionOptions } from '@wix/stores';

const wixClient = createClient({
  modules: { subscriptionOptions },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

async function bulkUpdateSubscriptionOptions(subscriptionOptions) {
  const response = await wixClient.subscriptionOptions.bulkUpdateSubscriptionOptions(subscriptionOptions);
}

bulkUpdateSubscriptionOptions() with Dashboard app access

bulkUpdateSubscriptionOptions

BulkUpdateSubscriptionOptionsResponse

subscriptionOption

SubscriptionOption

Creates a subscription option.
To assign to a product, call [`assignSubscriptionOptionsToProduct()`](https://www.wix.com/velo/reference/wix-stores-v2/subscriptionoptions/assign-subscription-options-to-product).
Subscription options that are not assigned to a product will not be visible in the Wix business manager.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { subscriptionOptions } from '@wix/stores';

const wixClient = createClient({
  modules: { subscriptionOptions },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function createSubscriptionOption(subscriptionOption) {
  const response = await wixClient.subscriptionOptions.createSubscriptionOption(subscriptionOption);
}

createSubscriptionOption() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { subscriptionOptions } from '@wix/stores';

const wixClient = createClient({
  modules: { subscriptionOptions },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

async function createSubscriptionOption(subscriptionOption) {
  const response = await wixClient.subscriptionOptions.createSubscriptionOption(subscriptionOption);
}

createSubscriptionOption() with Dashboard app access

createSubscriptionOption

Deletes a subscription option.
<blockquote class='warning'>

__Deprecation Notice:__

This endpoint has been deprecated and will be removed on January 29, 2024.

</blockquote>

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { subscriptionOptions } from '@wix/stores';

const wixClient = createClient({
  modules: { subscriptionOptions },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function deleteSubscriptionOption(id) {
  const response = await wixClient.subscriptionOptions.deleteSubscriptionOption(id);
}

deleteSubscriptionOption() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { subscriptionOptions } from '@wix/stores';

const wixClient = createClient({
  modules: { subscriptionOptions },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

async function deleteSubscriptionOption(id) {
  const response = await wixClient.subscriptionOptions.deleteSubscriptionOption(id);
}

deleteSubscriptionOption() with Dashboard app access

deleteSubscriptionOption

Checks whether a specified product (associated with subscription options) is available for one-time purchase.
<blockquote class='warning'>

__Deprecation Notice:__

This endpoint has been deprecated and will be removed on January 29, 2024.

</blockquote>

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { subscriptionOptions } from '@wix/stores';

const wixClient = createClient({
  modules: { subscriptionOptions },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function getOneTimePurchasesStatus(productId) {
  const response = await wixClient.subscriptionOptions.getOneTimePurchasesStatus(productId);
}

getOneTimePurchasesStatus() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { subscriptionOptions } from '@wix/stores';

const wixClient = createClient({
  modules: { subscriptionOptions },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

async function getOneTimePurchasesStatus(productId) {
  const response = await wixClient.subscriptionOptions.getOneTimePurchasesStatus(productId);
}

getOneTimePurchasesStatus() with Dashboard app access

getOneTimePurchasesStatus

GetOneTimePurchasesStatusResponse

GetProductIdsForSubscriptionOptionOptions

Retrieves the IDs of products associated with a specified subscription option.
<blockquote class='warning'>

__Deprecation Notice:__

This endpoint has been deprecated and will be removed on January 29, 2024.

</blockquote>

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { subscriptionOptions } from '@wix/stores';

const wixClient = createClient({
  modules: { subscriptionOptions },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function getProductIdsForSubscriptionOption(id, options) {
  const response = await wixClient.subscriptionOptions.getProductIdsForSubscriptionOption(id, options);
}

getProductIdsForSubscriptionOption() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { subscriptionOptions } from '@wix/stores';

const wixClient = createClient({
  modules: { subscriptionOptions },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

async function getProductIdsForSubscriptionOption(id, options) {
  const response = await wixClient.subscriptionOptions.getProductIdsForSubscriptionOption(id, options);
}

getProductIdsForSubscriptionOption() with Dashboard app access

getProductIdsForSubscriptionOption

GetProductIdsForSubscriptionOptionResponse

Retrieves a subscription option by ID.
<blockquote class='warning'>

__Deprecation Notice:__

This endpoint has been deprecated and will be removed on January 29, 2024.

</blockquote>

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { subscriptionOptions } from '@wix/stores';

const wixClient = createClient({
  modules: { subscriptionOptions },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function getSubscriptionOption(id) {
  const response = await wixClient.subscriptionOptions.getSubscriptionOption(id);
}

getSubscriptionOption() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { subscriptionOptions } from '@wix/stores';

const wixClient = createClient({
  modules: { subscriptionOptions },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

async function getSubscriptionOption(id) {
  const response = await wixClient.subscriptionOptions.getSubscriptionOption(id);
}

getSubscriptionOption() with Dashboard app access

getSubscriptionOption

GetSubscriptionOptionsForProductOptions

Retrieves all subscription options assigned to a specified product.
By default, hidden subscription options are not returned. To retrieve all subscription options you must pass `includeHiddenSubscriptionOptions = true`.
<blockquote class='warning'>

__Deprecation Notice:__

This endpoint has been deprecated and will be removed on January 29, 2024.

</blockquote>

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { subscriptionOptions } from '@wix/stores';

const wixClient = createClient({
  modules: { subscriptionOptions },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function getSubscriptionOptionsForProduct(productId, options) {
  const response = await wixClient.subscriptionOptions.getSubscriptionOptionsForProduct(productId, options);
}

getSubscriptionOptionsForProduct() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { subscriptionOptions } from '@wix/stores';

const wixClient = createClient({
  modules: { subscriptionOptions },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

async function getSubscriptionOptionsForProduct(productId, options) {
  const response = await wixClient.subscriptionOptions.getSubscriptionOptionsForProduct(productId, options);
}

getSubscriptionOptionsForProduct() with Dashboard app access

getSubscriptionOptionsForProduct

GetSubscriptionOptionsForProductResponse

Subscription option ID (auto-generated upon subscription option creation).

UpdateSubscriptionOption

Updates a subscription option.
Only parameters passed will be updated.
<blockquote class='warning'>

__Deprecation Notice:__

This endpoint has been deprecated and will be removed on January 29, 2024.

</blockquote>

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { subscriptionOptions } from '@wix/stores';

const wixClient = createClient({
  modules: { subscriptionOptions },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function updateSubscriptionOption(id, subscriptionOption) {
  const response = await wixClient.subscriptionOptions.updateSubscriptionOption(id, subscriptionOption);
}

updateSubscriptionOption() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { subscriptionOptions } from '@wix/stores';

const wixClient = createClient({
  modules: { subscriptionOptions },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

async function updateSubscriptionOption(id, subscriptionOption) {
  const response = await wixClient.subscriptionOptions.updateSubscriptionOption(id, subscriptionOption);
}

updateSubscriptionOption() with Dashboard app access

updateSubscriptionOption

To use the SubscriptionOptions API, install the `@wix/stores` package using npm or Yarn:
  ```console
npm install @wix/stores
```

or

```console
yarn add @wix/stores
```

Then import `{ subscriptionOptions }` from `@wix/stores`:

```js
import { subscriptionOptions } from '@wix/stores'
```
  

stores_subscription-options

Ordered array of subscription options that will be assigned to the product. Pass an empty array to remove all subscription options from the product.

assignedSubscriptionOptions

Discount

type

DiscountType

value

number

Whether the specified product is available for one-time purchase

Whether to include hidden products in the returned results.

includeHiddenProducts

paging

Paging

metadata

PagingMetadata

IDs of products associated with the specified subscription option.

productIds

totalResults

Whether to include hidden subscription options in the results.

includeHiddenSubscriptionOptions

limit

Number of items to skip in the display (relevant for all pages after the first).

offset

items

SubscriptionFrequency

Subscription option description (optional).

description

Discount info (optional).
For example, a $20 discount would be `value: 20`, `type: AMOUNT`.

discount

Subscription charge times. For example, if `frequency: MONTH` and `billingCycles: 6`; payment will be made monthly for 6 months.

subscriptionSettings

SubscriptionSettings

title

SubscriptionOptionInProduct

Whether the subscription option is hidden for the product (the default is false).

hidden

Subscription payment settings. For example, if `frequency: MONTH` and `billingCycles: 6`; payment will be made monthly for 6 months.

Whether subscription is renewed automatically at the end of each period.

autoRenewal

Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.

Setup

Permission Scopes

Permission Scopes

Permission Scopes