alerts.billing namespace

Functions

Function Description
onPlanAutomatedUpdatePublished(handler) Declares a function that can handle an automated billing plan update event.
onPlanAutomatedUpdatePublished(opts, handler) Declares a function that can handle an automated billing plan update event.
onPlanUpdatePublished(handler) Declares a function that can handle a billing plan update event.
onPlanUpdatePublished(opts, handler) Declares a function that can handle a billing plan update event.

Interfaces

Interface Description
BillingEvent A custom CloudEvent for billing Firebase Alerts (with custom extension attributes).
PlanAutomatedUpdatePayload The internal payload object for billing plan automated updates. Payload is wrapped inside a FirebaseAlertData object.
PlanUpdatePayload The internal payload object for billing plan updates. Payload is wrapped inside a FirebaseAlertData object.

alerts.billing.onPlanAutomatedUpdatePublished()

Declares a function that can handle an automated billing plan update event.

Signature:

export declare function onPlanAutomatedUpdatePublished(handler: (event: BillingEvent<PlanAutomatedUpdatePayload>) => any | Promise<any>): CloudFunction<BillingEvent<PlanAutomatedUpdatePayload>>;

Parameters

Parameter Type Description
handler (event: BillingEvent<PlanAutomatedUpdatePayload>) => any | Promise<any> Event handler which is run every time an automated billing plan update occurs.

Returns:

CloudFunction<BillingEvent<PlanAutomatedUpdatePayload>>

A function that you can export and deploy.

alerts.billing.onPlanAutomatedUpdatePublished()

Declares a function that can handle an automated billing plan update event.

Signature:

export declare function onPlanAutomatedUpdatePublished(opts: options.EventHandlerOptions, handler: (event: BillingEvent<PlanAutomatedUpdatePayload>) => any | Promise<any>): CloudFunction<BillingEvent<PlanAutomatedUpdatePayload>>;

Parameters

Parameter Type Description
opts options.EventHandlerOptions Options that can be set on the function.
handler (event: BillingEvent<PlanAutomatedUpdatePayload>) => any | Promise<any> Event handler which is run every time an automated billing plan update occurs.

Returns:

CloudFunction<BillingEvent<PlanAutomatedUpdatePayload>>

A function that you can export and deploy.

alerts.billing.onPlanUpdatePublished()

Declares a function that can handle a billing plan update event.

Signature:

export declare function onPlanUpdatePublished(handler: (event: BillingEvent<PlanUpdatePayload>) => any | Promise<any>): CloudFunction<BillingEvent<PlanUpdatePayload>>;

Parameters

Parameter Type Description
handler (event: BillingEvent<PlanUpdatePayload>) => any | Promise<any> Event handler which is run every time a billing plan is updated.

Returns:

CloudFunction<BillingEvent<PlanUpdatePayload>>

A function that you can export and deploy.

alerts.billing.onPlanUpdatePublished()

Declares a function that can handle a billing plan update event.

Signature:

export declare function onPlanUpdatePublished(opts: options.EventHandlerOptions, handler: (event: BillingEvent<PlanUpdatePayload>) => any | Promise<any>): CloudFunction<BillingEvent<PlanUpdatePayload>>;

Parameters

Parameter Type Description
opts options.EventHandlerOptions Options that can be set on the function.
handler (event: BillingEvent<PlanUpdatePayload>) => any | Promise<any> Event handler which is run every time a billing plan is updated.

Returns:

CloudFunction<BillingEvent<PlanUpdatePayload>>

A function that you can export and deploy.