memberListOrders( )

Retrieves a list of up to 100 pricing plan orders for currently logged-in member.

Method Declaration
Copy
function memberListOrders(
  options: MemberListOrdersOptions,
): Promise<MemberListOrdersResponse>;
Method Parameters
optionsMemberListOrdersOptions

Filtering, sorting, and pagination options.

Returns
Return Type:Promise<MemberListOrdersResponse>
JavaScript
import { orders } from "@wix/pricing-plans";

async function memberListOrders(options) {
  const response = await orders.memberListOrders(options);
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

pauseOrder( )

Pauses an order. Calling this method changes the order status to "PAUSED" and updates the pausePeriods array.

Only orders with status: ACTIVE can be paused. For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused. Pausing an order affects the end date of the order by adding the time the order is paused to the endDate. The endDate and the earliestEndDate for the order are adjusted to include the pause period when the order is resumed.

To resume a paused order, call Resume Order.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Orders
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
_idstringRequired

Order ID.

JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

postponeEndDate( )

Extends the duration of a pricing plan order by postponing the order's endDate. Postponing the end date of an order does not impact payments.

New endDate must be later than the order's current endDate. Can't postpone orders that are unlimited. Can't postpone an order with status: PAUSED.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Orders
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
_idstringRequired

Order ID.

endDateDateRequired

New end date and time.

Must be later than the current end date and time.

JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

requestCancellation( )

Cancels an order. Recurring orders can be canceled either immediately or at the next payment date. One time orders can only be canceled immediately.

There may be some operations that continue to be processed before the status of the order is changed to "CANCELED". For example, payments might need to be refunded before the order is fully canceled.

Canceling during the free trial period: When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end of the free trial period and they won't be billed. The buyer may continue using the benefits until the end of the free trial period.

Note: This method requires visitor or member authentication.

Method Declaration
Copy
Method Parameters
_idstringRequired

Order ID.

effectiveAtCancellationEffectiveAtRequired

Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately.

JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?