1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._createable_api_resource import CreateableAPIResource
from stripe._stripe_object import StripeObject
from typing import ClassVar, Optional, cast
from typing_extensions import Literal, Unpack, TYPE_CHECKING
if TYPE_CHECKING:
from stripe.params.billing._meter_event_adjustment_create_params import (
MeterEventAdjustmentCreateParams,
)
class MeterEventAdjustment(CreateableAPIResource["MeterEventAdjustment"]):
"""
A 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.
"""
OBJECT_NAME: ClassVar[Literal["billing.meter_event_adjustment"]] = (
"billing.meter_event_adjustment"
)
class Cancel(StripeObject):
identifier: Optional[str]
"""
Unique identifier for the event.
"""
cancel: Optional[Cancel]
"""
Specifies which event to cancel.
"""
event_name: str
"""
The name of the meter event. Corresponds with the `event_name` field on a meter.
"""
livemode: bool
"""
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
"""
object: Literal["billing.meter_event_adjustment"]
"""
String representing the object's type. Objects of the same type share the same value.
"""
status: Literal["complete", "pending"]
"""
The meter event adjustment's status.
"""
type: Literal["cancel"]
"""
Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.
"""
@classmethod
def create(
cls, **params: Unpack["MeterEventAdjustmentCreateParams"]
) -> "MeterEventAdjustment":
"""
Creates a billing meter event adjustment.
"""
return cast(
"MeterEventAdjustment",
cls._static_request(
"post",
cls.class_url(),
params=params,
),
)
@classmethod
async def create_async(
cls, **params: Unpack["MeterEventAdjustmentCreateParams"]
) -> "MeterEventAdjustment":
"""
Creates a billing meter event adjustment.
"""
return cast(
"MeterEventAdjustment",
await cls._static_request_async(
"post",
cls.class_url(),
params=params,
),
)
_inner_class_types = {"cancel": Cancel}
|
