Creates a link that can be used by a customer to preview the invoice.
The createInvoicePreviewUrl()
function returns a Promise that resolves
to a temporary link to a preview of the invoice with the specified ID.
You can get a list of invoices by querying your site's
"Billing/Invoices"
collection.
Each invoice in the query result contains the _id
and version
fields,
which must be used when calling createInvoicePreviewUrl()
.
By default, createInvoicePreviewUrl()
can be called by site contributors only.
To allow customers to generate the invoice preview link,
set suppressAuth
in the options
argument to true
.
function createInvoicePreviewUrl(
id: IdAndVersion,
options: AuthOptions,
): Promise<string>;
Object containing the ID and version of the invoice.
An object with the following boolean property: suppressAuth.
import { Permissions, webMethod } from "wix-web-module";
import { invoices } from "wix-billing-backend";
export const myCreateInvoicePreviewUrlFunction = webMethod(
Permissions.Anyone,
async (myInvoiceId, myInvoiceVersion) => {
const id = {
id: myInvoiceId,
version: myInvoiceVersion,
};
const options = {
suppressAuth: false,
};
return await invoices.createInvoicePreviewUrl(id, options);
},
);
/* Promise resolves to:
*
* "https://invoices.wix.com/invoice/4ffbe78f-d789-5f3b-9a01-e892987ee43e:a5af37a4-753d-4701-8518-be23920ac3a0/view?token=628fa483-a473-4408-bac7-7501e81b32e3"
*/
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.