@maxio-com/advanced-billing-sdk/src/models/chargifyEBB.ts

Ultimate billing and pricing flexibility for B2B SaaS. Maxio integrates directly into your product, so you can seamlessly manage your product catalog, bill customers, and collect payments.

/**
 * AdvancedBilling
 *
 * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ).
 */

import { expandoObject, number, optional, Schema, string } from '../schema.js';

export interface ChargifyEBB {
  /** This timestamp determines what billing period the event will be billed in. If your request payload does not include it, Chargify will add `chargify.timestamp` to the event payload and set the value to `now`. */
  timestamp?: string;
  /** A unique ID set by Chargify. This field is reserved. If `chargify.id` is present in the request payload, it will be overwritten. */
  id?: string;
  /** An ISO-8601 timestamp, set by Chargify at the time each event is recorded. This field is reserved. If `chargify.created_at` is present in the request payload, it will be overwritten. */
  createdAt?: string;
  /** User-defined string scoped per-stream. Duplicate events within a stream will be silently ignored. Tokens expire after 31 days. */
  uniquenessToken?: string;
  /**
   * Id of Maxio Advanced Billing Subscription which is connected to this event.
   * Provide `subscription_id` if you configured `chargify.subscription_id` as Subscription Identifier in your Event Stream.
   */
  subscriptionId?: number;
  /**
   * Reference of Maxio Advanced Billing Subscription which is connected to this event.
   * Provide `subscription_reference` if you configured `chargify.subscription_reference` as Subscription Identifier in your Event Stream.
   */
  subscriptionReference?: string;
  [key: string]: unknown;
}

export const chargifyEBBSchema: Schema<ChargifyEBB> = expandoObject({
  timestamp: ['timestamp', optional(string())],
  id: ['id', optional(string())],
  createdAt: ['created_at', optional(string())],
  uniquenessToken: ['uniqueness_token', optional(string())],
  subscriptionId: ['subscription_id', optional(number())],
  subscriptionReference: ['subscription_reference', optional(string())],
});