> 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 # InvoiceCreatedEvent # Package: appBilling # Namespace: CustomChargesProvider # Method link: https://dev.wix.com/docs/api-reference/app-management/app-billing/custom-charges-service-plugin/invoice-created-event.md ## Introduction Triggered in case Wix creates an invoice that includes charges for an instance of your app. --- ## REST API ### Schema ``` Method: invoiceCreatedEvent Description: Triggered in case Wix creates an invoice that includes charges for an instance of your app. URL: null Method: POST Method parameters: param name: currency | type: currency | description: Supported values: `AUD`, `BRL`, `CAD`, `EUR`, `GBP`, `ILS`, `INR`, `JPY`, `MXN`, `PLN`, `RUB`, `TRY`, `USD`. 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format of the charges. Wix may add supported currencies in the future. param name: invoiceId | type: invoiceId | description: GUID of the created invoice. param name: lineItems | type: array | description: Line items included in the invoice. - name: chargeId | type: string | description: GUID of the charge as returned in List Charges. Max: 64 characters - name: amount | type: string | description: Charge amount. - name: id | type: string | description: GUID of the line item in the invoice that Wix sends to the customer. param name: subscriptionId | type: subscriptionId | description: GUID of the subscription for which Wix has created an invoice that includes your custom charges. To track usage and billing for apps, we recommend to use `instanceId` instead of the `subscriptionId`. Return type: InvoiceCreatedResponse EMPTY-OBJECT {} ``` ### Examples ### Get notified when Wix creates an invoice with your custom charges. The data payload includes the following object as an encoded JWT. Here, we show the request and response objects decoded. ```curl curl -X POST \ 'https://provider.example.com/v1/invoice-created' \ -H 'Authorization: ' \ -d '{ "data": { "request": { "subscriptionId": "efa6b37d-74c6-44bb-b639-28c4af3957dd", "currency": "USD", "invoiceId": 43434213, "lineItems": [ { "chargeId": "Some Charge Id 1", "amount": "200.00", "id": "f322c4bf-7edb-42f8-b0c2-162b51d4ad75" }, { "chargeId": "Some Charge Id 2", "amount": "300.00", "id": "4faa44b4-654c-411d-803d-be816e03726e" } ] }, "metadata": { "requestId": "1680014776.67327419774788218037", "identity": { "identityType": "APP", "appId": "365288ae-38f4-4932-92d5-d45c596c7260" }, "instanceId": "3aa496c3-aa49-4369-84e6-3fa1876f191d" } }, "aud": "6675724b-bf3e-482a-9a00-65616953b570", "iss": "wix.com", "iat": 1680014777, "exp": 1683614777 }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.appBilling.CustomChargesProvider.invoiceCreatedEvent(request, metadata) Description: Triggered in case Wix creates an invoice that includes charges for an instance of your app. Method parameters: param name: metadata | type: Context | description: this message is not directly used by any service, it exists to describe the expected parameters that SHOULD be provided to invoked Velo methods as part of open-platform. e.g. SPIs, event-handlers, etc.. NOTE: this context object MUST be provided as the last argument in each Velo method signature. Example: ```typescript export function wixStores_onOrderCanceled({ event, metadata }: OrderCanceledEvent) { ... } ``` - name: requestId | type: string | description: A unique identifier of the request. You may print this GUID to your logs to help with future debugging and easier correlation with Wix's logs. - name: currency | type: string | description: [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code. - name: identity | type: IdentificationData | description: An object that describes the identity that triggered this request. - ONE-OF: - name: anonymousVisitorId | type: string | description: GUID of a site visitor that has not logged in to the site. - name: memberId | type: string | description: GUID of a site visitor that has logged in to the site. - name: wixUserId | type: string | description: GUID of a Wix user (site owner, contributor, etc.). - name: appId | type: string | description: GUID of an app. - name: languages | type: array | description: A string representing a language and region in the format of `"xx-XX"`. First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2. For example, `"en-US"`. - name: instanceId | type: string | description: The service provider app's instance GUID. param name: request | type: InvoiceCreatedRequest - name: subscriptionId | type: string | description: GUID of the subscription for which Wix has created an invoice that includes your custom charges. To track usage and billing for apps, we recommend to use `instanceId` instead of the `subscriptionId`. - name: currency | type: string | description: Supported values: `AUD`, `BRL`, `CAD`, `EUR`, `GBP`, `ILS`, `INR`, `JPY`, `MXN`, `PLN`, `RUB`, `TRY`, `USD`. 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format of the charges. Wix may add supported currencies in the future. - name: invoiceId | type: string | description: GUID of the created invoice. - name: lineItems | type: array | description: Line items included in the invoice. - name: chargeId | type: string | description: GUID of the charge as returned in List Charges. Max: 64 characters - name: amount | type: string | description: Charge amount. - name: _id | type: string | description: GUID of the line item in the invoice that Wix sends to the customer. Return type: PROMISE EMPTY-OBJECT {} ``` ### Examples ### Example of an invoice created event ```javascript import { customCharges } from '@wix/app-management/service-plugins'; customCharges.provideHandlers({ invoiceCreatedEvent: async ( payload ) => { const {request, metadata} = payload; // Use the `request` and `metadata` received from Wix and // apply custom logic. return {} } }); ``` ### invoiceCreatedEvent (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 { customCharges } from '@wix/app-management/service-plugins'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { customCharges }, // Include the auth strategy and host as relevant }); async function invoiceCreatedEvent(request,metadata) { const response = await myWixClient.customCharges.invoiceCreatedEvent(request,metadata); }; ``` ---