markAsPaid( )

Marks an offline order as paid.

Note: Marking separate payment cycles as paid is not yet supported. The entire order will be marked as paid. Subsequent offline payments do trigger events and emails, but are not registered as additional offline payments.

Marking an offline order as paid causes the following changes:

  • The order's lastPaymentStatus changes to "PAID".
  • The order's status changes to either "PENDING" or "ACTIVE", depending on the order's startDate.

An error occurs if you attempt to:

  • Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
  • Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
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
function markAsPaid(_id: string): Promise<void>;
Method Parameters
_idstringRequired

Order ID.

JavaScript
import { orders } from "@wix/pricing-plans";

async function markAsPaid(id) {
  const response = await orders.markAsPaid(id);
}
Errors

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

Did this help?