@getopenpay/client/models/CreateBillingMeterRequest.d.ts

OpenPay API TypeScript SDK

/**
 * OpenPay API
 * super charge your subscription management.
 *
 * The version of the OpenAPI document: 1.2.1
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { BillingMeterAggregationFormula } from './BillingMeterAggregationFormula';
/**
 *
 * @export
 * @interface CreateBillingMeterRequest
 */
export interface CreateBillingMeterRequest {
    /**
     * Specifies how events are aggregated. Allowed values are count to count the number of events and sum to sum each event’s value.
     * @type {BillingMeterAggregationFormula}
     * @memberof CreateBillingMeterRequest
     */
    aggregationFormula?: BillingMeterAggregationFormula;
    /**
     * The meter’s name.
     * @type {string}
     * @memberof CreateBillingMeterRequest
     */
    displayName: string;
    /**
     * The name of the meter event to record usage for. Corresponds with the event_name field on meter events.
     * @type {string}
     * @memberof CreateBillingMeterRequest
     */
    eventName: string;
    /**
     * The key in the usage event payload to use for mapping the event to a customer.
     * @type {string}
     * @memberof CreateBillingMeterRequest
     */
    eventPayloadCustomerMappingKey?: string;
    /**
     * The key in the usage event payload to use as the value for this meter. For example, if the event payload contains usage on a bytes_used field, then set the event_payload_value_key to “bytes_used”.
     * @type {string}
     * @memberof CreateBillingMeterRequest
     */
    eventPayloadValueKey?: string;
}
/**
 * Check if a given object implements the CreateBillingMeterRequest interface.
 */
export declare function instanceOfCreateBillingMeterRequest(value: object): value is CreateBillingMeterRequest;
export declare function CreateBillingMeterRequestFromJSON(json: any): CreateBillingMeterRequest;
export declare function CreateBillingMeterRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateBillingMeterRequest;
export declare function CreateBillingMeterRequestToJSON(json: any): CreateBillingMeterRequest;
export declare function CreateBillingMeterRequestToJSONTyped(value?: CreateBillingMeterRequest | null, ignoreDiscriminator?: boolean): any;