orb-billing 4.48.0 → 4.50.0

package/src/resources/customers/customers.ts

@@ -40,17 +40,17 @@ export class Customers extends APIResource {
 
   /**
    * This operation is used to create an Orb customer, who is party to the core
-   * billing relationship. See [Customer](../guides/concepts#customer) for an
-   * overview of the customer resource.
+   * billing relationship. See [Customer](/core-concepts##customer) for an overview
+   * of the customer resource.
    *
    * This endpoint is critical in the following Orb functionality:
    *
    * - Automated charges can be configured by setting `payment_provider` and
    *   `payment_provider_id` to automatically issue invoices
-   * - [Customer ID Aliases](../guides/events-and-metrics/customer-aliases) can be
-   *   configured by setting `external_customer_id`
-   * - [Timezone localization](../guides/product-catalog/timezones.md) can be
-   *   configured on a per-customer basis by setting the `timezone` parameter
+   * - [Customer ID Aliases](/events-and-metrics/customer-aliases) can be configured
+   *   by setting `external_customer_id`
+   * - [Timezone localization](/essentials/timezones) can be configured on a
+   *   per-customer basis by setting the `timezone` parameter
    */
   create(body: CustomerCreateParams, options?: Core.RequestOptions): Core.APIPromise<Customer> {
     return this._client.post('/customers', { body, ...options });
@@ -75,10 +75,9 @@ export class Customers extends APIResource {
    * This endpoint returns a list of all customers for an account. The list of
    * customers is ordered starting from the most recently created customer. This
    * endpoint follows Orb's
-   * [standardized pagination format](../reference/pagination).
+   * [standardized pagination format](/api-reference/pagination).
    *
-   * See [Customer](../guides/concepts#customer) for an overview of the customer
-   * model.
+   * See [Customer](/core-concepts##customer) for an overview of the customer model.
    */
   list(query?: CustomerListParams, options?: Core.RequestOptions): Core.PagePromise<CustomersPage, Customer>;
   list(options?: Core.RequestOptions): Core.PagePromise<CustomersPage, Customer>;
@@ -119,8 +118,8 @@ export class Customers extends APIResource {
    * `Customer` is in the process of being deleted, only the properties `id` and
    * `deleted: true` will be returned.
    *
-   * See the [Customer resource](../guides/core-concepts.mdx#customer) for a full
-   * discussion of the Customer model.
+   * See the [Customer resource](/core-concepts#customer) for a full discussion of
+   * the Customer model.
    */
   fetch(customerId: string, options?: Core.RequestOptions): Core.APIPromise<Customer> {
     return this._client.get(`/customers/${customerId}`, options);
@@ -128,7 +127,7 @@ export class Customers extends APIResource {
 
   /**
    * This endpoint is used to fetch customer details given an `external_customer_id`
-   * (see [Customer ID Aliases](../guides/events-and-metrics/customer-aliases)).
+   * (see [Customer ID Aliases](/events-and-metrics/customer-aliases)).
    *
    * Note that the resource and semantics of this endpoint exactly mirror
    * [Get Customer](fetch-customer).
@@ -139,8 +138,8 @@ export class Customers extends APIResource {
 
   /**
    * This endpoint is used to update customer details given an `external_customer_id`
-   * (see [Customer ID Aliases](../guides/events-and-metrics/customer-aliases)). Note
-   * that the resource and semantics of this endpoint exactly mirror
+   * (see [Customer ID Aliases](/events-and-metrics/customer-aliases)). Note that the
+   * resource and semantics of this endpoint exactly mirror
    * [Update Customer](update-customer).
    */
   updateByExternalId(
@@ -162,7 +161,7 @@ export class CustomersPage extends Page<Customer> {}
  * it's often desirable to have these match existing identifiers in your system. To
  * avoid having to denormalize Orb ID information, you can pass in an
  * `external_customer_id` with your own identifier. See
- * [Customer ID Aliases](../guides/events-and-metrics/customer-aliases) for further
+ * [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
  * information about how these aliases work in Orb.
  *
  * In addition to having an identifier in your system, a customer may exist in a
@@ -171,9 +170,8 @@ export class CustomersPage extends Page<Customer> {}
  *
  * A customer also has a timezone (from the standard
  * [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
- * your account's timezone. See
- * [Timezone localization](../guides/product-catalog/timezones.md) for information
- * on what this timezone parameter influences within Orb.
+ * your account's timezone. See [Timezone localization](/essentials/timezones) for
+ * information on what this timezone parameter influences within Orb.
  */
 export interface Customer {
   id: string;

package/src/resources/events/backfills.ts

@@ -38,12 +38,12 @@ export class Backfills extends APIResource {
    * affect all customers.
    *
    * When `replace_existing_events` is `true`, this indicates that existing events in
-   * the timeframe should no longer be counted towards invoiced usage. In this
+   * the timeframe should no longer be counter towards invoiced usage. In this
    * scenario, the parameter `filter` can be optionally added which enables filtering
    * using
-   * [computed properties](../guides/extensibility/advanced-metrics#computed-properties).
-   * The expressiveness of computed properties allows you to deprecate existing
-   * events based on both a period of time and specific property values.
+   * [computed properties](/extensibility/advanced-metrics#computed-properties). The
+   * expressiveness of computed properties allows you to deprecate existing events
+   * based on both a period of time and specific property values.
    */
   create(body: BackfillCreateParams, options?: Core.RequestOptions): Core.APIPromise<BackfillCreateResponse> {
     return this._client.post('/events/backfills', { body, ...options });
@@ -54,9 +54,9 @@ export class Backfills extends APIResource {
    *
    * The list of backfills is ordered starting from the most recently created
    * backfill. The response also includes
-   * [`pagination_metadata`](../reference/pagination), which lets the caller retrieve
-   * the next page of results if they exist. More information about pagination can be
-   * found in the [Pagination-metadata schema](pagination).
+   * [`pagination_metadata`](/api-reference/pagination), which lets the caller
+   * retrieve the next page of results if they exist. More information about
+   * pagination can be found in the [Pagination-metadata schema](pagination).
    */
   list(
     query?: BackfillListParams,
@@ -148,8 +148,8 @@ export interface BackfillCreateResponse {
 
   /**
    * A boolean
-   * [computed property](../guides/extensibility/advanced-metrics#computed-properties)
-   * used to filter the set of events to deprecate
+   * [computed property](/extensibility/advanced-metrics#computed-properties) used to
+   * filter the set of events to deprecate
    */
   deprecation_filter?: string | null;
 }
@@ -196,8 +196,8 @@ export interface BackfillListResponse {
 
   /**
    * A boolean
-   * [computed property](../guides/extensibility/advanced-metrics#computed-properties)
-   * used to filter the set of events to deprecate
+   * [computed property](/extensibility/advanced-metrics#computed-properties) used to
+   * filter the set of events to deprecate
    */
   deprecation_filter?: string | null;
 }
@@ -244,8 +244,8 @@ export interface BackfillCloseResponse {
 
   /**
    * A boolean
-   * [computed property](../guides/extensibility/advanced-metrics#computed-properties)
-   * used to filter the set of events to deprecate
+   * [computed property](/extensibility/advanced-metrics#computed-properties) used to
+   * filter the set of events to deprecate
    */
   deprecation_filter?: string | null;
 }
@@ -292,8 +292,8 @@ export interface BackfillFetchResponse {
 
   /**
    * A boolean
-   * [computed property](../guides/extensibility/advanced-metrics#computed-properties)
-   * used to filter the set of events to deprecate
+   * [computed property](/extensibility/advanced-metrics#computed-properties) used to
+   * filter the set of events to deprecate
    */
   deprecation_filter?: string | null;
 }
@@ -340,8 +340,8 @@ export interface BackfillRevertResponse {
 
   /**
    * A boolean
-   * [computed property](../guides/extensibility/advanced-metrics#computed-properties)
-   * used to filter the set of events to deprecate
+   * [computed property](/extensibility/advanced-metrics#computed-properties) used to
+   * filter the set of events to deprecate
    */
   deprecation_filter?: string | null;
 }
@@ -372,8 +372,8 @@ export interface BackfillCreateParams {
 
   /**
    * A boolean
-   * [computed property](../guides/extensibility/advanced-metrics#computed-properties)
-   * used to filter the set of events to deprecate
+   * [computed property](/extensibility/advanced-metrics#computed-properties) used to
+   * filter the set of events to deprecate
    */
   deprecation_filter?: string | null;
 

package/src/resources/events/events.ts

@@ -299,8 +299,8 @@ export class Events extends APIResource {
    *
    * If `debug=true` is not specified, the response will only contain
    * `validation_failed`. Orb will still honor the idempotency guarantees set
-   * [here](../guides/events-and-metrics/event-ingestion#event-volume-and-concurrency)
-   * in all cases.
+   * [here](/events-and-metrics/event-ingestion#event-volume-and-concurrency) in all
+   * cases.
    *
    * We strongly recommend that you only use debug mode as part of testing your
    * initial Orb integration. Once you're ready to switch to production, disable
@@ -333,7 +333,7 @@ export class Events extends APIResource {
 
   /**
    * This endpoint returns a filtered set of events for an account in a
-   * [paginated list format](../reference/pagination).
+   * [paginated list format](/api-reference/pagination).
    *
    * Note that this is a `POST` endpoint rather than a `GET` endpoint because it
    * employs a JSON body for search criteria rather than query parameters, allowing
@@ -412,10 +412,9 @@ export interface EventSearchResponse {
 
 export namespace EventSearchResponse {
   /**
-   * The [Event](../guides/core-concepts.mdx#event) resource represents a usage event
-   * that has been created for a customer. Events are the core of Orb's usage-based
-   * billing model, and are used to calculate the usage charges for a given billing
-   * period.
+   * The [Event](/core-concepts#event) resource represents a usage event that has
+   * been created for a customer. Events are the core of Orb's usage-based billing
+   * model, and are used to calculate the usage charges for a given billing period.
    */
   export interface Data {
     /**

package/src/resources/events/volume.ts

@@ -6,13 +6,13 @@ import * as Core from '../../core';
 export class Volume extends APIResource {
   /**
    * This endpoint returns the event volume for an account in a
-   * [paginated list format](../reference/pagination).
+   * [paginated list format](/api-reference/pagination).
    *
    * The event volume is aggregated by the hour and the
-   * [timestamp](../reference/ingest#determining-event-timestamp) field is used to
-   * determine which hour an event is associated with. Note, this means that
-   * late-arriving events increment the volume count for the hour window the
-   * timestamp is in, not the latest hour window.
+   * [timestamp](/api-reference/event/ingest-events) field is used to determine which
+   * hour an event is associated with. Note, this means that late-arriving events
+   * increment the volume count for the hour window the timestamp is in, not the
+   * latest hour window.
    *
    * Each item in the response contains the count of events aggregated by the hour
    * where the start and end time are hour-aligned and in UTC. When a specific

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

@@ -65,229 +65,8 @@ export interface InvoiceLineItemCreateResponse {
    * is serialized differently in a given Price object. The model_type field
    * determines the key for the configuration object that is present.
    *
-   * ## Unit pricing
-   *
-   * With unit pricing, each unit costs a fixed amount.
-   *
-   * ```json
-   * {
-   *     ...
-   *     "model_type": "unit",
-   *     "unit_config": {
-   *         "unit_amount": "0.50"
-   *     }
-   *     ...
-   * }
-   * ```
-   *
-   * ## Tiered pricing
-   *
-   * In tiered pricing, the cost of a given unit depends on the tier range that it
-   * falls into, where each tier range is defined by an upper and lower bound. For
-   * example, the first ten units may cost $0.50 each and all units thereafter may
-   * cost $0.10 each.
-   *
-   * ```json
-   * {
-   *     ...
-   *     "model_type": "tiered",
-   *     "tiered_config": {
-   *         "tiers": [
-   *             {
-   *                 "first_unit": 1,
-   *                 "last_unit": 10,
-   *                 "unit_amount": "0.50"
-   *             },
-   *             {
-   *                 "first_unit": 11,
-   *                 "last_unit": null,
-   *                 "unit_amount": "0.10"
-   *             }
-   *         ]
-   *     }
-   *     ...
-   * ```
-   *
-   * ## Bulk pricing
-   *
-   * Bulk pricing applies when the number of units determine the cost of all units.
-   * For example, if you've bought less than 10 units, they may each be $0.50 for a
-   * total of $5.00. Once you've bought more than 10 units, all units may now be
-   * priced at $0.40 (i.e. 101 units total would be $40.40).
-   *
-   * ```json
-   * {
-   *     ...
-   *     "model_type": "bulk",
-   *     "bulk_config": {
-   *         "tiers": [
-   *             {
-   *                 "maximum_units": 10,
-   *                 "unit_amount": "0.50"
-   *             },
-   *             {
-   *                 "maximum_units": 1000,
-   *                 "unit_amount": "0.40"
-   *             }
-   *         ]
-   *     }
-   *     ...
-   * }
-   * ```
-   *
-   * ## Package pricing
-   *
-   * Package pricing defines the size or granularity of a unit for billing purposes.
-   * For example, if the package size is set to 5, then 4 units will be billed as 5
-   * and 6 units will be billed at 10.
-   *
-   * ```json
-   * {
-   *     ...
-   *     "model_type": "package",
-   *     "package_config": {
-   *         "package_amount": "0.80",
-   *         "package_size": 10
-   *     }
-   *     ...
-   * }
-   * ```
-   *
-   * ## BPS pricing
-   *
-   * BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a
-   * percent (the number of basis points to charge), as well as a cap per event to
-   * assess. For example, this would allow you to assess a fee of 0.25% on every
-   * payment you process, with a maximum charge of $25 per payment.
-   *
-   * ```json
-   * {
-   *     ...
-   *     "model_type": "bps",
-   *     "bps_config": {
-   *        "bps": 125,
-   *        "per_unit_maximum": "11.00"
-   *     }
-   *     ...
-   *  }
-   * ```
-   *
-   * ## Bulk BPS pricing
-   *
-   * Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the
-   * total quantity across all events. Similar to bulk pricing, the BPS parameters of
-   * a given event depends on the tier range that the billing period falls into. Each
-   * tier range is defined by an upper bound. For example, after $1.5M of payment
-   * volume is reached, each individual payment may have a lower cap or a smaller
-   * take-rate.
-   *
-   * ```json
-   *     ...
-   *     "model_type": "bulk_bps",
-   *     "bulk_bps_config": {
-   *         "tiers": [
-   *            {
-   *                 "maximum_amount": "1000000.00",
-   *                 "bps": 125,
-   *                 "per_unit_maximum": "19.00"
-   *            },
-   *           {
-   *                 "maximum_amount": null,
-   *                 "bps": 115,
-   *                 "per_unit_maximum": "4.00"
-   *             }
-   *         ]
-   *     }
-   *     ...
-   * }
-   * ```
-   *
-   * ## Tiered BPS pricing
-   *
-   * Tiered BPS pricing specifies BPS parameters in a graduated manner, where an
-   * event's applicable parameter is a function of its marginal addition to the
-   * period total. Similar to tiered pricing, the BPS parameters of a given event
-   * depends on the tier range that it falls into, where each tier range is defined
-   * by an upper and lower bound. For example, the first few payments may have a 0.8
-   * BPS take-rate and all payments after a specific volume may incur a take-rate of
-   * 0.5 BPS each.
-   *
-   * ```json
-   *     ...
-   *     "model_type": "tiered_bps",
-   *     "tiered_bps_config": {
-   *         "tiers": [
-   *            {
-   *                 "minimum_amount": "0",
-   *                 "maximum_amount": "1000000.00",
-   *                 "bps": 125,
-   *                 "per_unit_maximum": "19.00"
-   *            },
-   *           {
-   *                 "minimum_amount": "1000000.00",
-   *                 "maximum_amount": null,
-   *                 "bps": 115,
-   *                 "per_unit_maximum": "4.00"
-   *             }
-   *         ]
-   *     }
-   *     ...
-   * }
-   * ```
-   *
-   * ## Matrix pricing
-   *
-   * Matrix pricing defines a set of unit prices in a one or two-dimensional matrix.
-   * `dimensions` defines the two event property values evaluated in this pricing
-   * model. In a one-dimensional matrix, the second value is `null`. Every
-   * configuration has a list of `matrix_values` which give the unit prices for
-   * specified property values. In a one-dimensional matrix, the matrix values will
-   * have `dimension_values` where the second value of the pair is null. If an event
-   * does not match any of the dimension values in the matrix, it will resort to the
-   * `default_unit_amount`.
-   *
-   * ```json
-   * {
-   *     "model_type": "matrix"
-   *     "matrix_config": {
-   *         "default_unit_amount": "3.00",
-   *         "dimensions": [
-   *             "cluster_name",
-   *             "region"
-   *         ],
-   *         "matrix_values": [
-   *             {
-   *                 "dimension_values": [
-   *                     "alpha",
-   *                     "west"
-   *                 ],
-   *                 "unit_amount": "2.00"
-   *             },
-   *             ...
-   *         ]
-   *     }
-   * }
-   * ```
-   *
-   * ## Fixed fees
-   *
-   * Fixed fees are prices that are applied independent of usage quantities, and
-   * follow unit pricing. They also have an additional parameter
-   * `fixed_price_quantity`. If the Price represents a fixed cost, this represents
-   * the quantity of units applied.
-   *
-   * ```json
-   * {
-   *     ...
-   *     "id": "price_id",
-   *     "model_type": "unit",
-   *     "unit_config": {
-   *        "unit_amount": "2.00"
-   *     },
-   *     "fixed_price_quantity": 3.0
-   *     ...
-   * }
-   * ```
+   * For more on the types of prices, see
+   * [the core concepts documentation](/core-concepts#plan-and-price)
    */
   price: PricesAPI.Price | null;