Liking cljdoc? Tell your friends :D

stripe-clojure.v2.billing.meter-event-adjustments

V2 Billing Meter Event Adjustments API.

Meter event adjustments allow you to correct or cancel previously reported meter events. This is useful when you need to:

  • Cancel events that were reported in error
  • Adjust usage values for billing corrections

Stripe docs: https://docs.stripe.com/api/v2/billing/meter_event_adjustments

V2 Billing Meter Event Adjustments API.

Meter event adjustments allow you to correct or cancel previously
reported meter events. This is useful when you need to:
- Cancel events that were reported in error
- Adjust usage values for billing corrections

Stripe docs: https://docs.stripe.com/api/v2/billing/meter_event_adjustments
raw docstring

create-meter-event-adjustmentclj

(create-meter-event-adjustment stripe-client params)
(create-meter-event-adjustment stripe-client params opts)

Creates a meter event adjustment to correct or cancel a previous event.

Use this to make billing corrections when meter events were reported incorrectly. Adjustments can cancel events entirely or adjust their values.

Parameters:

  • stripe-client: The Stripe client instance
  • params: The adjustment parameters
    • :event_name (required) - The name of the meter event to adjust
    • :type (required) - The type of adjustment: "cancel"
    • :cancel - Parameters for cancel adjustment
      • :identifier (required) - The identifier of the event to cancel
  • opts: Optional request options

Returns: The created meter event adjustment object.

Example - Cancel a specific event: (create-meter-event-adjustment client {:event_name "api_requests" :type "cancel" :cancel {:identifier "unique-event-id-123"}})

Creates a meter event adjustment to correct or cancel a previous event.

Use this to make billing corrections when meter events were reported
incorrectly. Adjustments can cancel events entirely or adjust their
values.

Parameters:
- stripe-client: The Stripe client instance
- params: The adjustment parameters
  - :event_name (required) - The name of the meter event to adjust
  - :type (required) - The type of adjustment: "cancel"
  - :cancel - Parameters for cancel adjustment
    - :identifier (required) - The identifier of the event to cancel
- opts: Optional request options

Returns:
The created meter event adjustment object.

Example - Cancel a specific event:
(create-meter-event-adjustment client
  {:event_name "api_requests"
   :type "cancel"
   :cancel {:identifier "unique-event-id-123"}})
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close