orb-billing 1.23.0 → 1.24.0

package/src/resources/customers/usage.ts

@@ -10,7 +10,7 @@ export class Usage extends APIResource {
    * an active subscription.
    *
    * This endpoint will mark _all_ existing events within
-   * `[timeframe_start, timeframe_end)` as _ignored_ for billing purpo ses, and Orb
+   * `[timeframe_start, timeframe_end)` as _ignored_ for billing purposes, and Orb
    * will only use the _new_ events passed in the body of this request as the source
    * of truth for that timeframe moving forwards. Note that a given time period can
    * be amended any number of times, so events can be overwritten in subsequent calls
@@ -22,7 +22,7 @@ export class Usage extends APIResource {
    * - decrease historical usage consumption because of degraded service availability
    *   in your systems
    * - account for gaps from your usage reporting mechanism
-   * - make point-in-time fixes for specific event records, while ret aining the
+   * - make point-in-time fixes for specific event records, while retaining the
    *   original time of usage and associated metadata. This amendment API is designed
    *   with two explicit goals:
    *
@@ -30,10 +30,10 @@ export class Usage extends APIResource {
    *    original events in the timeframe, though they will be ignored for billing
    *    calculations. For auditing a nd data fidelity purposes, Orb never overwrites
    *    or permanently deletes ingested usage data.
-   * 2. Amendments always preser ve data **consistency**. In other words, either an
-   *    amendment is fully processed by the system (and the new events for th e
+   * 2. Amendments always preserve data **consistency**. In other words, either an
+   *    amendment is fully processed by the system (and the new events for the
    *    timeframe are honored rather than the existing ones) or the amendment request
-   *    fails. To maintain this important proper ty, Orb prevents _partial event
+   *    fails. To maintain this important property, Orb prevents _partial event
    *    ingestion_ on this endpoint.
    *
    * ## Response semantics
@@ -45,12 +45,12 @@ export class Usage extends APIResource {
    *   also not deprecate existing events in the time period.
    * - You can assume that the amendment is successful on receipt of a `2xx`
    *   response.While a successful response from this endpoint indicates that the new
-   *   events have been ingested, updati ng usage totals happens asynchronously and
+   *   events have been ingested, updating usage totals happens asynchronously and
    *   may be delayed by a few minutes.
    *
    * As emphasized above, Orb will never show an inconsistent state (e.g. in invoice
    * previews or dashboards); either it will show the existing state (before the
-   * amend ment) or the new state (with new events in the requested timeframe).
+   * amendment) or the new state (with new events in the requested timeframe).
    *
    * ## Sample request body
    *
@@ -121,7 +121,7 @@ export class Usage extends APIResource {
    * an active subscription.
    *
    * This endpoint will mark _all_ existing events within
-   * `[timeframe_start, timeframe_end)` as _ignored_ for billing purpo ses, and Orb
+   * `[timeframe_start, timeframe_end)` as _ignored_ for billing purposes, and Orb
    * will only use the _new_ events passed in the body of this request as the source
    * of truth for that timeframe moving forwards. Note that a given time period can
    * be amended any number of times, so events can be overwritten in subsequent calls
@@ -133,7 +133,7 @@ export class Usage extends APIResource {
    * - decrease historical usage consumption because of degraded service availability
    *   in your systems
    * - account for gaps from your usage reporting mechanism
-   * - make point-in-time fixes for specific event records, while ret aining the
+   * - make point-in-time fixes for specific event records, while retaining the
    *   original time of usage and associated metadata. This amendment API is designed
    *   with two explicit goals:
    *
@@ -141,10 +141,10 @@ export class Usage extends APIResource {
    *    original events in the timeframe, though they will be ignored for billing
    *    calculations. For auditing a nd data fidelity purposes, Orb never overwrites
    *    or permanently deletes ingested usage data.
-   * 2. Amendments always preser ve data **consistency**. In other words, either an
-   *    amendment is fully processed by the system (and the new events for th e
+   * 2. Amendments always preserve data **consistency**. In other words, either an
+   *    amendment is fully processed by the system (and the new events for the
    *    timeframe are honored rather than the existing ones) or the amendment request
-   *    fails. To maintain this important proper ty, Orb prevents _partial event
+   *    fails. To maintain this important property, Orb prevents _partial event
    *    ingestion_ on this endpoint.
    *
    * ## Response semantics
@@ -156,12 +156,12 @@ export class Usage extends APIResource {
    *   also not deprecate existing events in the time period.
    * - You can assume that the amendment is successful on receipt of a `2xx`
    *   response.While a successful response from this endpoint indicates that the new
-   *   events have been ingested, updati ng usage totals happens asynchronously and
+   *   events have been ingested, updating usage totals happens asynchronously and
    *   may be delayed by a few minutes.
    *
    * As emphasized above, Orb will never show an inconsistent state (e.g. in invoice
    * previews or dashboards); either it will show the existing state (before the
-   * amend ment) or the new state (with new events in the requested timeframe).
+   * amendment) or the new state (with new events in the requested timeframe).
    *
    * ## Sample request body
    *
@@ -258,22 +258,9 @@ export interface UsageUpdateByExternalIDResponse {
 
 export interface UsageUpdateParams {
   /**
-   * Body param: A name to meaningfully identify the action or event type.
+   * Body param: Events to update
    */
-  event_name: string;
-
-  /**
-   * Body param: A dictionary of custom properties. Values in this dictionary must be
-   * numeric, boolean, or strings. Nested dictionaries are disallowed.
-   */
-  properties: unknown;
-
-  /**
-   * Body param: An ISO 8601 format date with no timezone offset (i.e. UTC). This
-   * should represent the time that usage was recorded, and is particularly important
-   * to attribute usage to a given billing period.
-   */
-  timestamp: string;
+  events: Array<UsageUpdateParams.Event>;
 
   /**
    * Query param: This bound is exclusive (i.e. events before this timestamp will be
@@ -286,37 +273,46 @@ export interface UsageUpdateParams {
    * inclusive will be updated)
    */
   timeframe_start?: string;
+}
 
-  /**
-   * Body param: The Orb Customer identifier
-   */
-  customer_id?: string | null;
+export namespace UsageUpdateParams {
+  export interface Event {
+    /**
+     * A name to meaningfully identify the action or event type.
+     */
+    event_name: string;
 
-  /**
-   * Body param: An alias for the Orb customer, whose mapping is specified when
-   * creating the customer
-   */
-  external_customer_id?: string | null;
-}
+    /**
+     * A dictionary of custom properties. Values in this dictionary must be numeric,
+     * boolean, or strings. Nested dictionaries are disallowed.
+     */
+    properties: unknown;
 
-export interface UsageUpdateByExternalIDParams {
-  /**
-   * Body param: A name to meaningfully identify the action or event type.
-   */
-  event_name: string;
+    /**
+     * An ISO 8601 format date with no timezone offset (i.e. UTC). This should
+     * represent the time that usage was recorded, and is particularly important to
+     * attribute usage to a given billing period.
+     */
+    timestamp: string;
 
-  /**
-   * Body param: A dictionary of custom properties. Values in this dictionary must be
-   * numeric, boolean, or strings. Nested dictionaries are disallowed.
-   */
-  properties: unknown;
+    /**
+     * The Orb Customer identifier
+     */
+    customer_id?: string | null;
+
+    /**
+     * An alias for the Orb customer, whose mapping is specified when creating the
+     * customer
+     */
+    external_customer_id?: string | null;
+  }
+}
 
+export interface UsageUpdateByExternalIDParams {
   /**
-   * Body param: An ISO 8601 format date with no timezone offset (i.e. UTC). This
-   * should represent the time that usage was recorded, and is particularly important
-   * to attribute usage to a given billing period.
+   * Body param: Events to update
    */
-  timestamp: string;
+  events: Array<UsageUpdateByExternalIDParams.Event>;
 
   /**
    * Query param: This bound is exclusive (i.e. events before this timestamp will be
@@ -329,17 +325,39 @@ export interface UsageUpdateByExternalIDParams {
    * inclusive will be updated)
    */
   timeframe_start?: string;
+}
 
-  /**
-   * Body param: The Orb Customer identifier
-   */
-  customer_id?: string | null;
+export namespace UsageUpdateByExternalIDParams {
+  export interface Event {
+    /**
+     * A name to meaningfully identify the action or event type.
+     */
+    event_name: string;
 
-  /**
-   * Body param: An alias for the Orb customer, whose mapping is specified when
-   * creating the customer
-   */
-  external_customer_id?: string | null;
+    /**
+     * A dictionary of custom properties. Values in this dictionary must be numeric,
+     * boolean, or strings. Nested dictionaries are disallowed.
+     */
+    properties: unknown;
+
+    /**
+     * An ISO 8601 format date with no timezone offset (i.e. UTC). This should
+     * represent the time that usage was recorded, and is particularly important to
+     * attribute usage to a given billing period.
+     */
+    timestamp: string;
+
+    /**
+     * The Orb Customer identifier
+     */
+    customer_id?: string | null;
+
+    /**
+     * An alias for the Orb customer, whose mapping is specified when creating the
+     * customer
+     */
+    external_customer_id?: string | null;
+  }
 }
 
 export namespace Usage {

package/src/resources/events/events.ts

@@ -120,47 +120,47 @@ export class Events extends APIResource {
    * Events are the starting point for all usage calculations in the system, and are
    * simple at their core:
    *
-   * ```json
+   * ```ts
    * {
-   * // customer_id and external_customer_id are used to
-   * // attribute usage to a given Customer. Exactly one of these
-   * // should be specified in a given ingestion event.
-   *
-   * // `customer_id` is the Orb generated identifier for the Customer,
-   * // which is returned from the Create customer API call.
-   * customer_id: string,
-   *
-   * // external_customer_id is an alternate identifier which is associated
-   * // with a Customer at creation time. This is treated as an alias for
-   * // customer_id, and is usually set to an identifier native to your system.
-   * external_customer_id: string,
-   *
-   * // A string name identifying the event, usually a usage
-   * // action. By convention, this should not contain any whitespace.
-   * event_name: string,
-   *
-   * // An ISO 8601 format date with no timezone offset.
-   * // This should represent the time that usage occurred
-   * // and is important to attribute usage to a given
-   * // billing period. See the notes below on determining the timestamp.
-   * // e.g. 2020-12-09T16:09:53Z
-   * timestamp: string,
-   *
-   * // A unique value, generated by the client, that is
-   * // used to de-duplicate events.
-   * // Exactly one event with a given
-   * // idempotency key will be ingested, which allows for
-   * // safe request retries.
-   * idempotency_key: string
-   *
-   * // Optional custom metadata to attach to the event.
-   * // This might include a numeric value used for aggregation,
-   * // or a string/boolean value used for filtering.
-   * // The schema of this dictionary need not be pre-declared, and
-   * // properties can be added at any time.
-   * properties: {
-   * [key: string]?: string | number | boolean,
-   * },
+   *   // customer_id and external_customer_id are used to
+   *   // attribute usage to a given Customer. Exactly one of these
+   *   // should be specified in a given ingestion event.
+   *
+   *   // `customer_id` is the Orb generated identifier for the Customer,
+   *   // which is returned from the Create customer API call.
+   *   customer_id: string,
+   *
+   *   // external_customer_id is an alternate identifier which is associated
+   *   // with a Customer at creation time. This is treated as an alias for
+   *   // customer_id, and is usually set to an identifier native to your system.
+   *   external_customer_id: string,
+   *
+   *   // A string name identifying the event, usually a usage
+   *   // action. By convention, this should not contain any whitespace.
+   *   event_name: string,
+   *
+   *   // An ISO 8601 format date with no timezone offset.
+   *   // This should represent the time that usage occurred
+   *   // and is important to attribute usage to a given
+   *   // billing period. See the notes below on determining the timestamp.
+   *   // e.g. 2020-12-09T16:09:53Z
+   *   timestamp: string,
+   *
+   *   // A unique value, generated by the client, that is
+   *   // used to de-duplicate events.
+   *   // Exactly one event with a given
+   *   // idempotency key will be ingested, which allows for
+   *   // safe request retries.
+   *   idempotency_key: string
+   *
+   *   // Optional custom metadata to attach to the event.
+   *   // This might include a numeric value used for aggregation,
+   *   // or a string/boolean value used for filtering.
+   *   // The schema of this dictionary need not be pre-declared, and
+   *   // properties can be added at any time.
+   *   properties: {
+   *     [key: string]?: string | number | boolean,
+   *   },
    * }
    * ```
    *

package/src/resources/index.ts

@@ -1,5 +1,6 @@
 // File generated from our OpenAPI spec by Stainless.
 
+export * from './shared';
 export { Coupon, CouponCreateParams, CouponListParams, CouponsPage, Coupons } from './coupons/coupons';
 export { CreditNote, CreditNoteListParams, CreditNotesPage, CreditNotes } from './credit-notes';
 export {
@@ -11,7 +12,6 @@ export {
   CustomersPage,
   Customers,
 } from './customers/customers';
-export { Discount, Price, PriceCreateParams, PriceListParams, PricesPage, Prices } from './prices/prices';
 export {
   EventUpdateResponse,
   EventDeprecateResponse,
@@ -24,7 +24,6 @@ export {
 } from './events/events';
 export {
   Invoice,
-  InvoiceDiscount,
   InvoiceFetchUpcomingResponse,
   InvoiceCreateParams,
   InvoiceListParams,
@@ -49,10 +48,11 @@ export {
   Metrics,
 } from './metrics';
 export { Plan, PlanCreateParams, PlanUpdateParams, PlanListParams, PlansPage, Plans } from './plans/plans';
+export { Price, PriceCreateParams, PriceListParams, PricesPage, Prices } from './prices/prices';
 export {
   Subscription,
-  Subscriptions,
   SubscriptionUsage,
+  Subscriptions,
   SubscriptionFetchCostsResponse,
   SubscriptionFetchScheduleResponse,
   SubscriptionCreateParams,

package/src/resources/invoice-line-items.ts

@@ -3,7 +3,7 @@
 import * as Core from "../core";
 import { APIResource } from "../resource";
 import * as InvoiceLineItemsAPI from "./invoice-line-items";
-import * as InvoicesAPI from "./invoices";
+import * as Shared from "./shared";
 import * as PricesAPI from "./prices/prices";
 
 export class InvoiceLineItems extends APIResource {
@@ -30,7 +30,7 @@ export interface InvoiceLineItemCreateResponse {
    */
   amount: string;
 
-  discount: InvoicesAPI.InvoiceDiscount | null;
+  discount: Shared.Discount | null;
 
   /**
    * The end date of the range of time applied for this line item's price.