Skip to content

Stripe: Create a billing meter event adjustment

Stripe billing.postBillingMeterEventAdjustments: arguments, response, policy and SDK examples.

← Billing operations · Get started

Operation stripe.postbillingmetereventadjustments

Provider route: POST /v1/billing/meter_event_adjustments. Alter supplies the connection’s credentials and routing.

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"]["postBillingMeterEventAdjustments"]>[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.postBillingMeterEventAdjustments(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_meter_event_adjustments(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
headersobjectOptionalAdditional keys: not allowed
headers.Idempotency-KeystringOptionalMinimum length: 1
Maximum length: 255
bodyobjectRequired within parentAdditional keys: not allowed
body.cancelobjectOptionalSpecifies which event to cancel.
body.cancel.identifierstringOptionalMaximum length: 100
body.event_namestringRequired within parentThe name of the meter event. Corresponds with the `event_name` field on a meter.
Maximum length: 100
body.expandarrayOptionalSpecifies which fields in the response should be expanded.
body.expand[]stringEach itemMaximum length: 5000
body.typestringRequired within parentSpecifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.
One of: cancel

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Create a billing meter event adjustment — response body

Referenced models: Create a billing meter event adjustment — response body

Create a billing meter event adjustment — response body
FieldTypePresenceDescription and constraints
$objectRootA billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer.
cancelJSONOptional
cancel (anyOf 1)JSONAlternativeSpecifies which event to cancel.
cancel (anyOf 1) (anyOf 1)ModelAlternativeExpand Create a billing meter event adjustment — response body — cancel Specifies which event to cancel identifier
cancel (anyOf 2)nullAlternative
event_namestringRequired within parentThe name of the meter event. Corresponds with the `event_name` field on a meter.
Maximum length: 100
livemodebooleanRequired within parentIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: billing.meter_event_adjustment
statusstringRequired within parentThe meter event adjustment's status.
Known values: complete, pending
typestringRequired within parentSpecifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.
Known values: cancel

Referenced models: Create a billing meter event adjustment — response body — cancel Specifies which event to cancel identifier

Create a billing meter event adjustment — response body — cancel Specifies which event to cancel identifier
FieldTypePresenceDescription and constraints
$objectRoot
identifierJSONOptional
identifier (anyOf 1)stringAlternativeUnique identifier for the event.
Maximum length: 100
identifier (anyOf 2)nullAlternative

SDK function policy ID: stripe.postbillingmetereventadjustments. Catalog operation: PostBillingMeterEventAdjustments. 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

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.