Stripe: Activate a billing alert

← Billing operations · Get started

Operation stripe.postbillingalertsidactivate

Provider route: POST /v1/billing/alerts/{id}/activate. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { StripeIntegration } from "@alter-ai/stripe";

async function execute(input: Parameters<StripeIntegration["billing"]["postBillingAlertsIdActivate"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.billing.postBillingAlertsIdActivate(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_stripe import StripeIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.billing.post_billing_alerts_id_activate(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.id	string	Required within parent	Maximum length: 5000
headers	object	Optional	Additional keys: not allowed
headers.Idempotency-Key	string	Optional	Minimum length: 1 Maximum length: 255
body	object	Optional	Additional keys: not allowed
body.expand	array	Optional	Specifies which fields in the response should be expanded.
body.expand[]	string	Each item	Maximum length: 5000

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Create a billing alert — response body

Referenced models: Create a billing alert — response body

Schemas

707 more schemas are linked from the tables above, on the schema pages.

Create a billing alert — response body

Field	Type	Presence	Description and constraints
$	object	Root	A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.
alert_type	string	Required within parent	Defines the type of the alert. Known values: usage_threshold
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: billing.alert
status	JSON	Optional
status (anyOf 1)	string	Alternative	Status of the alert. This can be active, inactive or archived. Known values: active, archived, inactive
status (anyOf 2)	null	Alternative
title	string	Required within parent	Title of the alert. Maximum length: 5000
usage_threshold	JSON	Optional
usage_threshold (anyOf 1)	JSON	Alternative	Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://docs.stripe.com/api/billing/meter).
usage_threshold (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a billing alert — response body — usage_threshold / value / recurrence: one time
usage_threshold (anyOf 2)	null	Alternative

Referenced models: Create a billing alert — response body — usage_threshold / value / recurrence: one time

Create a billing alert — response body — usage_threshold / value / recurrence: one time

Field	Type	Presence	Description and constraints
$	object	Root	The usage threshold alert configuration enables setting up alerts for when a certain usage threshold on a specific meter is crossed.
filters	JSON	Optional
filters (anyOf 1)	array	Alternative	The filters allow limiting the scope of this usage alert. You can only specify up to one filter at this time.
filters (anyOf 1)[]	Model	Each item	Expand Create a billing alert — response body — usage_threshold / value / recurrence: one time filters array item
filters (anyOf 2)	null	Alternative
gte	JSON	Required within parent
gte (anyOf 1)	integer	Alternative	The value at which this alert will trigger.
gte (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
meter	JSON	Required within parent	The [Billing Meter](/api/billing/meter) ID whose usage is monitored.
meter (anyOf 1)	string	Alternative	Maximum length: 5000
meter (anyOf 2)	Model	Alternative	Expand Create a billing meter — response body
recurrence	string	Required within parent	Defines how the alert will behave. Known values: one_time

Referenced models: Create a billing meter — response body, Create a billing alert — response body — usage_threshold / value / recurrence: one time filters array item

Create a billing meter — response body

Field	Type	Presence	Description and constraints
$	object	Root	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	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
customer_mapping	Model	Required within parent	Expand Create a billing meter — response body — customer mapping
default_aggregation	Model	Required within parent	Expand Create a billing meter — response body — default aggregation
display_name	string	Required within parent	The meter's name. Maximum length: 5000
event_name	string	Required within parent	The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events. Maximum length: 5000
event_time_window	JSON	Optional
event_time_window (anyOf 1)	string	Alternative	The time window which meter events have been pre-aggregated for, if any. Known values: day, hour
event_time_window (anyOf 2)	null	Alternative
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: billing.meter
status	string	Required within parent	The meter's status. Known values: active, inactive
status_transitions	Model	Required within parent	Expand Create a billing meter — response body — status transitions
updated	JSON	Required within parent
updated (anyOf 1)	integer	Alternative	Time at which the object was last updated. Measured in seconds since the Unix epoch. Format: unix-time
updated (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value_settings	Model	Required within parent	Expand Create a billing meter — response body — value settings

Referenced models: Create a billing meter — response body — default aggregation, Create a billing meter — response body — status transitions, Create a billing meter — response body — value settings, Create a billing meter — response body — customer mapping

Create a billing alert — response body — usage_threshold / value / recurrence: one time filters array item

Field	Type	Presence	Description and constraints
$	object	Root
customer	JSON	Optional
customer (anyOf 1)	JSON	Alternative	Limit the scope of the alert to this customer ID
customer (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
customer (anyOf 1) (anyOf 2)	Model	Alternative	Expand Create a customer — response body
customer (anyOf 2)	null	Alternative
type	string	Required within parent	Known values: customer

Referenced models: Create a customer — response body

Create a billing meter — response body — default aggregation

Field	Type	Presence	Description and constraints
$	object	Root
formula	string	Required within parent	Specifies how events are aggregated. Known values: count, last, sum

Create a billing meter — response body — status transitions

Field	Type	Presence	Description and constraints
$	object	Root
deactivated_at	JSON	Optional
deactivated_at (anyOf 1)	JSON	Alternative
deactivated_at (anyOf 1) (anyOf 1)	integer	Alternative	The time the meter was deactivated, if any. Measured in seconds since Unix epoch. Format: unix-time
deactivated_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
deactivated_at (anyOf 2)	null	Alternative

Create a billing meter — response body — value settings

Field	Type	Presence	Description and constraints
$	object	Root
event_payload_key	string	Required within parent	The key in the meter event payload to use as the value for this meter. Maximum length: 5000

Create a billing meter — response body — customer mapping

Field	Type	Presence	Description and constraints
$	object	Root
event_payload_key	string	Required within parent	The key in the meter event payload to use for mapping the event to a customer. Maximum length: 5000
type	string	Required within parent	The method for mapping a meter event to a customer. Known values: by_id

Delete a customer — response body

Field	Type	Presence	Description and constraints
$	object	Root
deleted	boolean	Required within parent	Always true for a deleted object Known values: True
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: customer

Create a Payment Method — response body — zip

Field	Type	Presence	Description and constraints
$	object	Root

Policy, approvals and errors

SDK function policy ID: stripe.postbillingalertsidactivate. Catalog operation: PostBillingAlertsIdActivate. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Stripe-Version": "2026-09-30.endive"}

Official provider source