---
title: "List billing alerts"
method: GET
path: "/v1/billing/alerts"
---

# List billing alerts

`GET /v1/billing/alerts`

Lists billing active and inactive alerts

## Query parameters

- `alert_type` 'usage_threshold'
- `ending_before` string
- `expand` string[]
- `limit` integer
- `meter` string
- `starting_after` string

## Response `200`

Successful response.

- object
  - `data` BillingAlert[], required
    - `alert_type` 'usage_threshold', required — Defines the type of the alert.
    - `id` string, required — Unique identifier for the object.
    - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
    - `object` 'billing.alert', required — String representing the object's type. Objects of the same type share the same value.
    - `status` 'active' | 'archived' | 'inactive', nullable — Status of the alert. This can be active, inactive or archived.
    - `title` string, required — Title of the alert.
    - `usage_threshold` ThresholdsResourceUsageThresholdConfig — The usage threshold alert configuration enables setting up alerts for when a certain usage threshold on a specific meter is crossed.
      - `filters` ThresholdsResourceUsageAlertFilter[], nullable — The filters allow limiting the scope of this usage alert. You can only specify up to one filter at this time.
        - `customer` union — Limit the scope of the alert to this customer ID
          - string
          - Customer — This object represents a customer of your business. Use it to [create recurring charges](https://docs.stripe.com/invoicing/customer), [save payment](https://docs.stripe.com/payments/save-during-payment) and contact information, and track payments that belong to the same customer.
            - `address` Address
              - …
            - `balance` integer — The current balance, if any, that's stored on the customer in their default currency. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. For multi-currency balances, see [invoice_credit_balance](https://docs.stripe.com/api/customers/object#customer_object-invoice_credit_balance).
            - `business_name` string — The customer's business name.
            - `cash_balance` CashBalance — A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account.
              - …
            - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch.
            - `currency` string, nullable — Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes.
            - `customer_account` string, nullable — The ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter.
            - `default_source` union — ID of the default payment source for the customer. If you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead.
              - …
            - `delinquent` boolean, nullable — Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the `invoice.due_date` will set this field to `true`. If an invoice becomes uncollectible by [dunning](https://docs.stripe.com/billing/automatic-collection), `delinquent` doesn't reset to `false`. If you care whether the customer has paid their most recent subscription invoice, use `subscription.status` instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to `false`.
            - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users.
            - `discount` Discount — A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes). It contains information about when the discount began, when it will end, and what it is applied to. Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts)
              - …
            - `email` string, nullable — The customer's email address.
            - `id` string, required — Unique identifier for the object.
            - `individual_name` string — The customer's individual name.
            - `invoice_credit_balance` object — The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes.
            - `invoice_prefix` string, nullable — The prefix for the customer used to generate unique invoice numbers.
            - `invoice_settings` InvoiceSettingCustomerSetting
              - …
            - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
            - `metadata` object — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
            - `name` string, nullable — The customer's full name or business name.
            - `next_invoice_sequence` integer — The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses.
            - `object` 'customer', required — String representing the object's type. Objects of the same type share the same value.
            - `phone` string, nullable — The customer's phone number.
            - `preferred_locales` string[], nullable — The customer's preferred locales (languages), ordered by preference.
            - `shipping` Shipping
              - …
            - `sources` object — The customer's payment sources, if any.
              - …
            - `subscriptions` object — The customer's current subscriptions, if any.
              - …
            - `tax` CustomerTax
              - …
            - `tax_exempt` 'exempt' | 'none' | 'reverse', nullable — Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **"Reverse charge"**.
            - `tax_ids` object — The customer's tax IDs.
              - …
            - `test_clock` union — ID of the test clock that this customer belongs to.
              - …
        - `type` 'customer', required
      - `gte` integer, required — The value at which this alert will trigger.
      - `meter` union, required — The [Billing Meter](/api/billing/meter) ID whose usage is monitored.
        - string
        - BillingMeter — Meters specify how to aggregate meter events over a billing period. Meter events represent the actions that customers take in your system. Meters attach to prices and form the basis of the bill. Related guide: [Usage based billing](https://docs.stripe.com/billing/subscriptions/usage-based)
          - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch.
          - `customer_mapping` BillingMeterResourceCustomerMappingSettings, required
            - `event_payload_key` string, required — The key in the meter event payload to use for mapping the event to a customer.
            - `type` 'by_id', required — The method for mapping a meter event to a customer.
          - `default_aggregation` BillingMeterResourceAggregationSettings, required
            - `formula` 'count' | 'last' | 'sum', required — Specifies how events are aggregated.
          - `display_name` string, required — The meter's name.
          - `event_name` string, required — The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events.
          - `event_time_window` 'day' | 'hour', nullable — The time window which meter events have been pre-aggregated for, if any.
          - `id` string, required — Unique identifier for the object.
          - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
          - `object` 'billing.meter', required — String representing the object's type. Objects of the same type share the same value.
          - `status` 'active' | 'inactive', required — The meter's status.
          - `status_transitions` BillingMeterResourceBillingMeterStatusTransitions, required
            - `deactivated_at` integer, nullable — The time the meter was deactivated, if any. Measured in seconds since Unix epoch.
          - `updated` integer, required — Time at which the object was last updated. Measured in seconds since the Unix epoch.
          - `value_settings` BillingMeterResourceBillingMeterValue, required
            - `event_payload_key` string, required — The key in the meter event payload to use as the value for this meter.
      - `recurrence` 'one_time', required — Defines how the alert will behave.
  - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched.
  - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
  - `url` string, required — The URL where this list can be accessed.

## Other responses

- `default` — Error response.

---

[API](https://skmtc.net/stripe/apis/stripe-api-2.md) · [All operations](https://skmtc.net/stripe/apis/stripe-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stripe/stripe-api-2/versions/3653ad45bbec/schema)