class Stripe::BillingApi
- Stripe::BillingApi
- Reference
- Object
Defined in:
stripe/api/billing_api.crConstant Summary
-
GET_BILLING_METERS_ID_EVENT_SUMMARIES_MAX_LENGTH_FOR_CUSTOMER =
5000 -
GET_BILLING_METERS_ID_EVENT_SUMMARIES_MAX_LENGTH_FOR_ENDING_BEFORE =
5000 -
GET_BILLING_METERS_ID_EVENT_SUMMARIES_MAX_LENGTH_FOR_ID =
5000 -
GET_BILLING_METERS_ID_EVENT_SUMMARIES_MAX_LENGTH_FOR_STARTING_AFTER =
5000 -
GET_BILLING_METERS_ID_EVENT_SUMMARIES_VALID_VALUES_FOR_VALUE_GROUPING_WINDOW =
String.static_array("day", "hour") -
GET_BILLING_METERS_ID_MAX_LENGTH_FOR_ID =
5000 -
GET_BILLING_METERS_MAX_LENGTH_FOR_ENDING_BEFORE =
5000 -
GET_BILLING_METERS_MAX_LENGTH_FOR_STARTING_AFTER =
5000 -
GET_BILLING_METERS_VALID_VALUES_FOR_STATUS =
String.static_array("active", "inactive") -
POST_BILLING_METER_EVENT_ADJUSTMENTS_MAX_LENGTH_FOR_EVENT_NAME =
100 -
POST_BILLING_METER_EVENT_ADJUSTMENTS_VALID_VALUES_FOR__TYPE =
String.static_array("cancel") -
POST_BILLING_METER_EVENTS_MAX_LENGTH_FOR_EVENT_NAME =
100 -
POST_BILLING_METER_EVENTS_MAX_LENGTH_FOR_IDENTIFIER =
100 -
POST_BILLING_METERS_ID_DEACTIVATE_MAX_LENGTH_FOR_ID =
5000 -
POST_BILLING_METERS_ID_MAX_LENGTH_FOR_DISPLAY_NAME =
250 -
POST_BILLING_METERS_ID_MAX_LENGTH_FOR_ID =
5000 -
POST_BILLING_METERS_ID_REACTIVATE_MAX_LENGTH_FOR_ID =
5000 -
POST_BILLING_METERS_MAX_LENGTH_FOR_DISPLAY_NAME =
250 -
POST_BILLING_METERS_MAX_LENGTH_FOR_EVENT_NAME =
100 -
POST_BILLING_METERS_VALID_VALUES_FOR_EVENT_TIME_WINDOW =
String.static_array("day", "hour")
Constructors
Instance Method Summary
- #api_client : ApiClient
- #api_client=(api_client : ApiClient)
-
#build_api_request_for_get_billing_meters(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, status : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_billing_meters_id(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_billing_meters_id_event_summaries(*, customer : String | Nil = nil, start_time : Int64 | Nil = nil, end_time : Int64 | Nil = nil, id : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, value_grouping_window : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_billing_meter_event_adjustments(*, event_name : String | Nil = nil, _type : String | Nil = nil, cancel : Stripe::EventAdjustmentCancelSettingsParam | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_billing_meter_events(*, event_name : String | Nil = nil, payload : Hash(String, String) | Nil = nil, expand : Array(String) | Nil = nil, identifier : String | Nil = nil, timestamp : Int64 | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_billing_meters(*, default_aggregation : Stripe::AggregationSettingsParam | Nil = nil, display_name : String | Nil = nil, event_name : String | Nil = nil, customer_mapping : Stripe::CustomerMappingParam | Nil = nil, event_time_window : String | Nil = nil, expand : Array(String) | Nil = nil, value_settings : Stripe::MeterValueSettingsParam | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_billing_meters_id(*, id : String | Nil = nil, display_name : String | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_billing_meters_id_deactivate(*, id : String | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_billing_meters_id_reactivate(*, id : String | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request
@return Crest::Request
- #client_side_validation?(*args, **options)
- #client_side_validation?(*args, **options, &)
- #debugging?(*args, **options)
- #debugging?(*args, **options, &)
-
#get_billing_meters(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, status : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::BillingMeterResourceBillingMeterList
Retrieve a list of billing meters.
@optional @param ending_before [String?] A cursor for use in pagination. -
#get_billing_meters(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, status : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Retrieve a list of billing meters.</p> @optional @param ending_before [String?] A cursor for use in pagination.
-
#get_billing_meters_id(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::BillingMeter
Retrieves a billing meter given an ID
@required @param id [String?] Unique identifier for the object. -
#get_billing_meters_id(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Retrieves a billing meter given an ID</p> @required @param id [String?] Unique identifier for the object.
-
#get_billing_meters_id_event_summaries(*, customer : String | Nil = nil, start_time : Int64 | Nil = nil, end_time : Int64 | Nil = nil, id : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, value_grouping_window : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::BillingMeterResourceBillingMeterEventSummaryList
Retrieve a list of billing meter event summaries.
@required @param customer [String?] The customer for which to fetch event summaries. -
#get_billing_meters_id_event_summaries(*, customer : String | Nil = nil, start_time : Int64 | Nil = nil, end_time : Int64 | Nil = nil, id : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, value_grouping_window : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Retrieve a list of billing meter event summaries.</p> @required @param customer [String?] The customer for which to fetch event summaries.
-
#get_billing_meters_id_event_summaries_with_http_info(*, customer : String | Nil = nil, start_time : Int64 | Nil = nil, end_time : Int64 | Nil = nil, id : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, value_grouping_window : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::BillingMeterResourceBillingMeterEventSummaryList, Int32, Hash(String, Array(String) | String))
<p>Retrieve a list of billing meter event summaries.</p> @required @param customer [String?] The customer for which to fetch event summaries.
-
#get_billing_meters_id_with_http_info(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::BillingMeter, Int32, Hash(String, Array(String) | String))
<p>Retrieves a billing meter given an ID</p> @required @param id [String?] Unique identifier for the object.
-
#get_billing_meters_with_http_info(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, status : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::BillingMeterResourceBillingMeterList, Int32, Hash(String, Array(String) | String))
<p>Retrieve a list of billing meters.</p> @optional @param ending_before [String?] A cursor for use in pagination.
-
#post_billing_meter_event_adjustments(*, event_name : String | Nil = nil, _type : String | Nil = nil, cancel : Stripe::EventAdjustmentCancelSettingsParam | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::BillingMeterEventAdjustment
Creates a billing meter event adjustment
@required @param event_name [String?] The name of the meter event. -
#post_billing_meter_event_adjustments(*, event_name : String | Nil = nil, _type : String | Nil = nil, cancel : Stripe::EventAdjustmentCancelSettingsParam | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Creates a billing meter event adjustment</p> @required @param event_name [String?] The name of the meter event.
-
#post_billing_meter_event_adjustments_with_http_info(*, event_name : String | Nil = nil, _type : String | Nil = nil, cancel : Stripe::EventAdjustmentCancelSettingsParam | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::BillingMeterEventAdjustment, Int32, Hash(String, Array(String) | String))
<p>Creates a billing meter event adjustment</p> @required @param event_name [String?] The name of the meter event.
-
#post_billing_meter_events(*, event_name : String | Nil = nil, payload : Hash(String, String) | Nil = nil, expand : Array(String) | Nil = nil, identifier : String | Nil = nil, timestamp : Int64 | Nil = nil) : Stripe::BillingMeterEvent
Creates a billing meter event
@required @param event_name [String?] The name of the meter event. -
#post_billing_meter_events(*, event_name : String | Nil = nil, payload : Hash(String, String) | Nil = nil, expand : Array(String) | Nil = nil, identifier : String | Nil = nil, timestamp : Int64 | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Creates a billing meter event</p> @required @param event_name [String?] The name of the meter event.
-
#post_billing_meter_events_with_http_info(*, event_name : String | Nil = nil, payload : Hash(String, String) | Nil = nil, expand : Array(String) | Nil = nil, identifier : String | Nil = nil, timestamp : Int64 | Nil = nil) : Tuple(Stripe::BillingMeterEvent, Int32, Hash(String, Array(String) | String))
<p>Creates a billing meter event</p> @required @param event_name [String?] The name of the meter event.
-
#post_billing_meters(*, default_aggregation : Stripe::AggregationSettingsParam | Nil = nil, display_name : String | Nil = nil, event_name : String | Nil = nil, customer_mapping : Stripe::CustomerMappingParam | Nil = nil, event_time_window : String | Nil = nil, expand : Array(String) | Nil = nil, value_settings : Stripe::MeterValueSettingsParam | Nil = nil) : Stripe::BillingMeter
Creates a billing meter
@required @param default_aggregation [Stripe::AggregationSettingsParam?] @required @param display_name [String?] The meter's name. -
#post_billing_meters(*, default_aggregation : Stripe::AggregationSettingsParam | Nil = nil, display_name : String | Nil = nil, event_name : String | Nil = nil, customer_mapping : Stripe::CustomerMappingParam | Nil = nil, event_time_window : String | Nil = nil, expand : Array(String) | Nil = nil, value_settings : Stripe::MeterValueSettingsParam | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Creates a billing meter</p> @required @param default_aggregation [Stripe::AggregationSettingsParam?] @required @param display_name [String?] The meter's name.
-
#post_billing_meters_id(*, id : String | Nil = nil, display_name : String | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::BillingMeter
Updates a billing meter
@required @param id [String?] Unique identifier for the object. -
#post_billing_meters_id(*, id : String | Nil = nil, display_name : String | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Updates a billing meter</p> @required @param id [String?] Unique identifier for the object.
-
#post_billing_meters_id_deactivate(*, id : String | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::BillingMeter
Deactivates a billing meter
@required @param id [String?] Unique identifier for the object. -
#post_billing_meters_id_deactivate(*, id : String | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Deactivates a billing meter</p> @required @param id [String?] Unique identifier for the object.
-
#post_billing_meters_id_deactivate_with_http_info(*, id : String | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::BillingMeter, Int32, Hash(String, Array(String) | String))
<p>Deactivates a billing meter</p> @required @param id [String?] Unique identifier for the object.
-
#post_billing_meters_id_reactivate(*, id : String | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::BillingMeter
Reactivates a billing meter
@required @param id [String?] Unique identifier for the object. -
#post_billing_meters_id_reactivate(*, id : String | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Reactivates a billing meter</p> @required @param id [String?] Unique identifier for the object.
-
#post_billing_meters_id_reactivate_with_http_info(*, id : String | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::BillingMeter, Int32, Hash(String, Array(String) | String))
<p>Reactivates a billing meter</p> @required @param id [String?] Unique identifier for the object.
-
#post_billing_meters_id_with_http_info(*, id : String | Nil = nil, display_name : String | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::BillingMeter, Int32, Hash(String, Array(String) | String))
<p>Updates a billing meter</p> @required @param id [String?] Unique identifier for the object.
-
#post_billing_meters_with_http_info(*, default_aggregation : Stripe::AggregationSettingsParam | Nil = nil, display_name : String | Nil = nil, event_name : String | Nil = nil, customer_mapping : Stripe::CustomerMappingParam | Nil = nil, event_time_window : String | Nil = nil, expand : Array(String) | Nil = nil, value_settings : Stripe::MeterValueSettingsParam | Nil = nil) : Tuple(Stripe::BillingMeter, Int32, Hash(String, Array(String) | String))
<p>Creates a billing meter</p> @required @param default_aggregation [Stripe::AggregationSettingsParam?] @required @param display_name [String?] The meter's name.
Constructor Detail
Instance Method Detail
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
Retrieve a list of billing meters.
@optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param status [String?] Filter results to only include meters with the given status. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::BillingMeterResourceBillingMeterList]<p>Retrieve a list of billing meters.</p>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param status [String?] Filter results to only include meters with the given status.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return nil
Retrieves a billing meter given an ID
@required @param id [String?] Unique identifier for the object. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::BillingMeter]<p>Retrieves a billing meter given an ID</p> @required @param id [String?] Unique identifier for the object. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
Retrieve a list of billing meter event summaries.
@required @param customer [String?] The customer for which to fetch event summaries. @required @param start_time [Int32?] The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries. @required @param end_time [Int32?] The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries. @required @param id [String?] Unique identifier for the object. @optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param value_grouping_window [String?] Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. For hourly granularity, start and end times must align with hour boundaries (e.g., 00:00, 01:00, ..., 23:00). For daily granularity, start and end times must align with UTC day boundaries (00:00 UTC). @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::BillingMeterResourceBillingMeterEventSummaryList]<p>Retrieve a list of billing meter event summaries.</p>
@required @param customer [String?] The customer for which to fetch event summaries.
@required @param start_time [Int32?] The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.
@required @param end_time [Int32?] The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.
@required @param id [String?] Unique identifier for the object.
@optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param value_grouping_window [String?] Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. For hourly granularity, start and end times must align with hour boundaries (e.g., 00:00, 01:00, ..., 23:00). For daily granularity, start and end times must align with UTC day boundaries (00:00 UTC).
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return nil
<p>Retrieve a list of billing meter event summaries.</p>
@required @param customer [String?] The customer for which to fetch event summaries.
@required @param start_time [Int32?] The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.
@required @param end_time [Int32?] The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.
@required @param id [String?] Unique identifier for the object.
@optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param value_grouping_window [String?] Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. For hourly granularity, start and end times must align with hour boundaries (e.g., 00:00, 01:00, ..., 23:00). For daily granularity, start and end times must align with UTC day boundaries (00:00 UTC).
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return [Tuple(Stripe::BillingMeterResourceBillingMeterEventSummaryList, Integer, Hash)] Stripe::BillingMeterResourceBillingMeterEventSummaryList, response status code and response headers
<p>Retrieves a billing meter given an ID</p> @required @param id [String?] Unique identifier for the object. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::BillingMeter, Integer, Hash)] Stripe::BillingMeter, response status code and response headers
<p>Retrieve a list of billing meters.</p>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param status [String?] Filter results to only include meters with the given status.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return [Tuple(Stripe::BillingMeterResourceBillingMeterList, Integer, Hash)] Stripe::BillingMeterResourceBillingMeterList, response status code and response headers
Creates a billing meter event adjustment
@required @param event_name [String?] The name of the meter event. Corresponds with the `event_name` field on a meter. @required @param _type [String?] Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet. @optional @param cancel [Stripe::EventAdjustmentCancelSettingsParam?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::BillingMeterEventAdjustment]<p>Creates a billing meter event adjustment</p>
@required @param event_name [String?] The name of the meter event. Corresponds with the event_name field on a meter.
@required @param _type [String?] Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.
@optional @param cancel [Stripe::EventAdjustmentCancelSettingsParam?]
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@return nil
<p>Creates a billing meter event adjustment</p>
@required @param event_name [String?] The name of the meter event. Corresponds with the event_name field on a meter.
@required @param _type [String?] Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.
@optional @param cancel [Stripe::EventAdjustmentCancelSettingsParam?]
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@return [Tuple(Stripe::BillingMeterEventAdjustment, Integer, Hash)] Stripe::BillingMeterEventAdjustment, response status code and response headers
Creates a billing meter event
@required @param event_name [String?] The name of the meter event. Corresponds with the `event_name` field on a meter. @required @param payload [Hash(String, String)?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param identifier [String?] A unique identifier for the event. If not provided, one will be generated. We recommend using a globally unique identifier for this. We'll enforce uniqueness within a rolling 24 hour period. @optional @param timestamp [Int32?] The time of the event. Measured in seconds since the Unix epoch. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to current timestamp if not specified. @return [Stripe::BillingMeterEvent]<p>Creates a billing meter event</p>
@required @param event_name [String?] The name of the meter event. Corresponds with the event_name field on a meter.
@required @param payload [Hash(String, String)?]
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param identifier [String?] A unique identifier for the event. If not provided, one will be generated. We recommend using a globally unique identifier for this. We'll enforce uniqueness within a rolling 24 hour period.
@optional @param timestamp [Int32?] The time of the event. Measured in seconds since the Unix epoch. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to current timestamp if not specified.
@return nil
<p>Creates a billing meter event</p>
@required @param event_name [String?] The name of the meter event. Corresponds with the event_name field on a meter.
@required @param payload [Hash(String, String)?]
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param identifier [String?] A unique identifier for the event. If not provided, one will be generated. We recommend using a globally unique identifier for this. We'll enforce uniqueness within a rolling 24 hour period.
@optional @param timestamp [Int32?] The time of the event. Measured in seconds since the Unix epoch. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to current timestamp if not specified.
@return [Tuple(Stripe::BillingMeterEvent, Integer, Hash)] Stripe::BillingMeterEvent, response status code and response headers
Creates a billing meter
@required @param default_aggregation [Stripe::AggregationSettingsParam?] @required @param display_name [String?] The meter's name. @required @param event_name [String?] The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events. @optional @param customer_mapping [Stripe::CustomerMappingParam?] @optional @param event_time_window [String?] The time window to pre-aggregate meter events for, if any. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param value_settings [Stripe::MeterValueSettingsParam?] @return [Stripe::BillingMeter]<p>Creates a billing meter</p>
@required @param default_aggregation [Stripe::AggregationSettingsParam?]
@required @param display_name [String?] The meter's name.
@required @param event_name [String?] The name of the meter event to record usage for. Corresponds with the event_name field on meter events.
@optional @param customer_mapping [Stripe::CustomerMappingParam?]
@optional @param event_time_window [String?] The time window to pre-aggregate meter events for, if any.
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param value_settings [Stripe::MeterValueSettingsParam?]
@return nil
Updates a billing meter
@required @param id [String?] Unique identifier for the object. @optional @param display_name [String?] The meter's name. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::BillingMeter]<p>Updates a billing meter</p> @required @param id [String?] Unique identifier for the object. @optional @param display_name [String?] The meter's name. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil
Deactivates a billing meter
@required @param id [String?] Unique identifier for the object. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::BillingMeter]<p>Deactivates a billing meter</p> @required @param id [String?] Unique identifier for the object. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil
<p>Deactivates a billing meter</p> @required @param id [String?] Unique identifier for the object. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::BillingMeter, Integer, Hash)] Stripe::BillingMeter, response status code and response headers
Reactivates a billing meter
@required @param id [String?] Unique identifier for the object. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::BillingMeter]<p>Reactivates a billing meter</p> @required @param id [String?] Unique identifier for the object. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil
<p>Reactivates a billing meter</p> @required @param id [String?] Unique identifier for the object. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::BillingMeter, Integer, Hash)] Stripe::BillingMeter, response status code and response headers
<p>Updates a billing meter</p> @required @param id [String?] Unique identifier for the object. @optional @param display_name [String?] The meter's name. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::BillingMeter, Integer, Hash)] Stripe::BillingMeter, response status code and response headers
<p>Creates a billing meter</p>
@required @param default_aggregation [Stripe::AggregationSettingsParam?]
@required @param display_name [String?] The meter's name.
@required @param event_name [String?] The name of the meter event to record usage for. Corresponds with the event_name field on meter events.
@optional @param customer_mapping [Stripe::CustomerMappingParam?]
@optional @param event_time_window [String?] The time window to pre-aggregate meter events for, if any.
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param value_settings [Stripe::MeterValueSettingsParam?]
@return [Tuple(Stripe::BillingMeter, Integer, Hash)] Stripe::BillingMeter, response status code and response headers