> 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 # CancelPackage # Package: resellers # Namespace: Packages # Method link: https://dev.wix.com/docs/api-reference/account-level/resellers/packages-and-product-instances/cancel-package.md ## Introduction Cancels all product instances included in the package and the customer immediately loses access to the canceled functionality. You must pass the ID of the Wix account that the package belongs to in the header of the call. The call fails, if the package and Wix account don't match. If a canceled product instance is a requirement for another Wix service, that functionality is also no longer available to the customer. For example, if you cancel a Premium plan, a previously connected domain is automatically disconnected from the site. > **Important**: This call requires an account level API key and cannot be > authenticated with the standard authorization header. --- ## REST API ### Schema ``` Method: cancelPackage Description: Cancels all product instances included in the package and the customer immediately loses access to the canceled functionality. You must pass the GUID of the Wix account that the package belongs to in the header of the call. The call fails, if the package and Wix account don't match. If a canceled product instance is a requirement for another Wix service, that functionality is also no longer available to the customer. For example, if you cancel a Premium plan, a previously connected domain is automatically disconnected from the site. > **Important**: This call requires an account level API key and cannot be > authenticated with the standard authorization header. URL: https://www.wixapis.com/resellers/v1/packages/{id} Method: DELETE # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: id Method parameters: param name: id | type: none | required: true query param name: idempotencyKey | type: idempotencyKey | description: Idempotency key. | validation: maxLength 100 Return type: CancelPackageResponse - name: idempotencyKey | type: string | description: Idempotency key. | validation: maxLength 100 - name: package | type: Package | description: Canceled package. - name: id | type: string | description: Package GUID. | validation: format GUID - name: accountId | type: string | description: Wix account GUID. See [Account Level APIs](https://dev.wix.com/docs/rest/account-level/about-account-level-apis.md) for more details. | validation: format GUID - name: externalId | type: string | description: External reference. For example, an external subscription GUID. This field isn't validated by Wix. Max: 100 characters | validation: maxLength 100 - name: productInstances | type: array | description: Product instances that are included in the package. Min: 1 product instance Max: 1000 product instances | validation: minItems 1, maxItems 1000 - ONE-OF: - name: billingInfo | type: Cycle | description: Billing information for the contract between the reseller and Wix. - name: type | type: CycleDescriptorType | description: Payment type. - enum: - ONE_TIME: The reseller pays Wix in a single payment. - RECURRING: The reseller pays Wix on a recurring schedule. - name: cycleDuration | type: Interval | description: Duration of the billing cycle. Available only for `RECURRING` payments. - name: unit | type: IntervalUnit | description: Unit of the billing cycle. - enum: - DAY: Day - WEEK: Week - MONTH: Month - YEAR: Year - name: count | type: integer | description: Count of units that make up the billing cycle. | validation: minimum 1 - name: instanceId | type: string | description: GUID of the instance of the resold Wix service. **Note:** Differs from the `catalogProductId`. Allows you to identify different instances of the same product in a package. | validation: format GUID - name: siteId | type: string | description: GUID of the Wix site that the product instance is assigned to. See the [Query Sites API](https://dev.wix.com/api/rest/account-level-apis/sites/query-sites) for more information. | validation: format GUID - name: catalogProductId | type: string | description: Product GUID, as defined in the Wix Premium Product Catalog. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for more details about available Wix services. | validation: format GUID - name: status | type: Status | description: Status of the product instance. - enum: - PENDING: The product instance isn't yet available to the customer. - ENABLED: The customer can use the product instance. - CANCELED: The product instance isn't any longer available to the customer. - FAILED: The product instance couldn't be delivered successfully and has never been available to the customer. - AWAITING_ACTION: The product instance isn't yet available to the customer, because an external provider or the customer must take an action. - name: failure | type: FailureReason | description: Failure object. Only present for status `FAILED`. Describes why the product instance `FAILED`. - name: code | type: FailureReasonCode | description: Failure code. - enum: - DELIVERY_TIMEOUT: The product instance couldn't be created because the Resellers API timed out. - EXTERNAL_FAILURE: The product instance couldn't be created because an external process failed. - name: message | type: string | description: Failure message. - name: createdDate | type: string | description: Date and time the product instance was created. | validation: format date-time - name: updatedDate | type: string | description: Date and time the product instance was last updated. | validation: format date-time - name: countryCode | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. Specifies where customers can claim vouchers that may come with the product. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) to get more information about vouchers and supported locations. | validation: format COUNTRY - name: expirationDate | type: string | description: Date and time the product instance expires in `YYYY-MM-DDThh:mm:ss.sssZ` format. Used only for instances that don't auto renew at the end of the current billing cycle. | validation: format date-time - name: discountCode | type: string | description: Discount code indicating that the reseller provisioned the product instance during a sale. Wix doesn't guarantee that a discount code reduces the price between Wix and the reseller, even when it's valid. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for more information. Max: 25 characters | validation: maxLength 25 - name: referenceProductInstanceId | type: string | description: GUID of a different product instance that you can use to offer your customers time-limited free access to an additional product or service. For example, Wix offers a 1-year free domain registration to all customers who purchase a Premium plan. The referenced product instance must have either status `"PENDING"` or `"ACTIVE"`. You can use each product instance only a single time as reference instance. | validation: format GUID - name: createdDate | type: string | description: Date and time the package was created. | validation: format date-time - name: updatedDate | type: string | description: Date and time the package was last updated. | validation: format date-time ``` ### Examples ### Cancel a package ```curl curl -X DELETE \ 'www.wixapis.com/resellers/v1/packages/828b98fb-7114-4b3c-90fd-8d0db76aa72b' \ -H 'wix-account-id: ' \ -H 'Content-Type: application/json' \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.packages.packages.cancelPackage(_id, options) Description: Cancels all product instances included in the package and the customer immediately loses access to the canceled functionality. You must pass the GUID of the Wix account that the package belongs to in the header of the call. The call fails, if the package and Wix account don't match. If a canceled product instance is a requirement for another Wix service, that functionality is also no longer available to the customer. For example, if you cancel a Premium plan, a previously connected domain is automatically disconnected from the site. > **Important**: This call requires an account level API key and cannot be > authenticated with the standard authorization header. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: _id Method parameters: param name: _id | type: string | description: GUID of the package to cancel. | required: true | validation: format GUID param name: options | type: CancelPackageOptions none - name: idempotencyKey | type: string | description: Idempotency key. | validation: maxLength 100 Return type: PROMISE - name: idempotencyKey | type: string | description: Idempotency key. | validation: maxLength 100 - name: package | type: Package | description: Canceled package. - name: _id | type: string | description: Package GUID. | validation: format GUID - name: accountId | type: string | description: Wix account GUID. See [Account Level APIs](https://dev.wix.com/docs/rest/account-level/about-account-level-apis.md) for more details. | validation: format GUID - name: externalId | type: string | description: External reference. For example, an external subscription GUID. This field isn't validated by Wix. Max: 100 characters | validation: maxLength 100 - name: productInstances | type: array | description: Product instances that are included in the package. Min: 1 product instance Max: 1000 product instances | validation: minItems 1, maxItems 1000 - ONE-OF: - name: billingInfo | type: Cycle | description: Billing information for the contract between the reseller and Wix. - name: type | type: CycleDescriptorType | description: Payment type. - enum: - ONE_TIME: The reseller pays Wix in a single payment. - RECURRING: The reseller pays Wix on a recurring schedule. - name: cycleDuration | type: Interval | description: Duration of the billing cycle. Available only for `RECURRING` payments. - name: unit | type: IntervalUnit | description: Unit of the billing cycle. - enum: - DAY: Day - WEEK: Week - MONTH: Month - YEAR: Year - name: count | type: integer | description: Count of units that make up the billing cycle. | validation: minimum 1 - name: instanceId | type: string | description: GUID of the instance of the resold Wix service. **Note:** Differs from the `catalogProductId`. Allows you to identify different instances of the same product in a package. | validation: format GUID - name: siteId | type: string | description: GUID of the Wix site that the product instance is assigned to. See the [Query Sites API](https://dev.wix.com/api/rest/account-level-apis/sites/query-sites) for more information. | validation: format GUID - name: catalogProductId | type: string | description: Product GUID, as defined in the Wix Premium Product Catalog. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for more details about available Wix services. | validation: format GUID - name: status | type: Status | description: Status of the product instance. - enum: - PENDING: The product instance isn't yet available to the customer. - ENABLED: The customer can use the product instance. - CANCELED: The product instance isn't any longer available to the customer. - FAILED: The product instance couldn't be delivered successfully and has never been available to the customer. - AWAITING_ACTION: The product instance isn't yet available to the customer, because an external provider or the customer must take an action. - name: failure | type: FailureReason | description: Failure object. Only present for status `FAILED`. Describes why the product instance `FAILED`. - name: code | type: FailureReasonCode | description: Failure code. - enum: - DELIVERY_TIMEOUT: The product instance couldn't be created because the Resellers API timed out. - EXTERNAL_FAILURE: The product instance couldn't be created because an external process failed. - name: message | type: string | description: Failure message. - name: _createdDate | type: Date | description: Date and time the product instance was created. - name: _updatedDate | type: Date | description: Date and time the product instance was last updated. - name: countryCode | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. Specifies where customers can claim vouchers that may come with the product. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) to get more information about vouchers and supported locations. | validation: format COUNTRY - name: expirationDate | type: Date | description: Date and time the product instance expires in `YYYY-MM-DDThh:mm:ss.sssZ` format. Used only for instances that don't auto renew at the end of the current billing cycle. - name: discountCode | type: string | description: Discount code indicating that the reseller provisioned the product instance during a sale. Wix doesn't guarantee that a discount code reduces the price between Wix and the reseller, even when it's valid. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for more information. Max: 25 characters | validation: maxLength 25 - name: referenceProductInstanceId | type: string | description: GUID of a different product instance that you can use to offer your customers time-limited free access to an additional product or service. For example, Wix offers a 1-year free domain registration to all customers who purchase a Premium plan. The referenced product instance must have either status `"PENDING"` or `"ACTIVE"`. You can use each product instance only a single time as reference instance. | validation: format GUID - name: _createdDate | type: Date | description: Date and time the package was created. - name: _updatedDate | type: Date | description: Date and time the package was last updated. ``` ### Examples ### Cancel a package with an API key ```javascript import { createClient, ApiKeyStrategy } from "@wix/sdk"; import { packages } from "@wix/packages"; const wixClient = createClient({ modules: { packages }, auth: ApiKeyStrategy({ apiKey: "MY-API-KEY", }), }); async function cancelPackage(id, options) { const response = await packages.cancelPackage(id, options); } ``` ### cancelPackage (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 { packages } from '@wix/packages'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { packages }, // Include the auth strategy and host as relevant }); async function cancelPackage(_id,options) { const response = await myWixClient.packages.cancelPackage(_id,options); }; ``` ---