BillingAlerts

Returns the Billing Alerts in Stripe and supports creating them.

Table-Specific Information

SELECT

The driver uses the Stripe API to filter the results by the following columns and operators:


Column	Supported Operators
Id	=
AlertType	=
Meter	=

The rest of the filter is executed client-side within the driver.

You can select from the BillingAlerts table with the following queries:

SELECT * FROM BillingAlerts
SELECT * FROM BillingAlerts WHERE Id = 'alrt_61StTIaW2Fbu9eu8g41ATXQzBWNrl3s8'
SELECT * FROM BillingAlerts WHERE AlertType = 'usage_threshold'
SELECT * FROM BillingAlerts WHERE Meter = 'mtr_61SsKmAO0UJqejE4X41ATXQzBWNrlL3A'

INSERT

To create a new billing alert, AlertType, Title, UsageThresholdGte, UsageThresholdMeter, UsageThresholdRecurrence, and UsageThresholdFilters are required.

INSERT INTO BillingAlerts (AlertType, Title, UsageThresholdGte, UsageThresholdMeter, UsageThresholdRecurrence, UsageThresholdFilters) VALUES ('usage_threshold', 'test by driver', '55899', 'mtr_61SsKmAO0UJqejE4X41ATXQzBWNrlL3A', 'one_time', '[{\"type\": \"customer\" , \"customer\":\"cus_PlAgkzgwf099eS\"}]')

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Unique identifier for the object.
Object	String	True		The string representing the object's type. Objects of the same type share the same value.
AlertType	String	False		Defines the type of the alert. Use usage_threshold if you intend for an alert to fire when a usage threshold on a meter is crossed. The allowed values are usage_threshold.
Livemode	Boolean	True		Indicates whether the object exists in live mode. The value is true in live mode and false in test mode.
Status	String	True		The status of the alert. This can be active, inactive, or archived. The allowed values are active, inactive, archived.
Title	String	False		The title of the alert.
UsageThresholdFilters	String	False		The filters allow limiting the scope of this usage alert. You can only specify up to one filter at this time. Limit the scope of the alert to this customer Id.
UsageThresholdGte	Integer	False		The value at which this alert triggers.
UsageThresholdMeterId	String	False		The Billing Meter Id whose usage is monitored.
UsageThresholdRecurrence	String	False		Defines how the alert behaves. The allowed values are one_time.

Pseudocolumns

Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.