orb-billing 4.49.0 → 4.51.0

package/resources/customers/costs.d.ts

@@ -5,8 +5,8 @@ export declare class Costs extends APIResource {
     /**
      * This endpoint is used to fetch a day-by-day snapshot of a customer's costs in
      * Orb, calculated by applying pricing information to the underlying usage (see the
-     * [subscription usage endpoint](fetch-subscription-usage.api.mdx) to fetch usage
-     * per metric, in usage units rather than a currency).
+     * [subscription usage endpoint](/api-reference/subscription/fetch-subscription-usage)
+     * to fetch usage per metric, in usage units rather than a currency).
      *
      * This endpoint can be leveraged for internal tooling and to provide a more
      * transparent billing experience for your end users:
@@ -15,8 +15,8 @@ export declare class Costs extends APIResource {
      *    the current billing period.
      * 2. Provide customer visibility into how different services are contributing to
      *    the overall invoice with a per-day timeseries (as compared to the
-     *    [upcoming invoice](fetch-upcoming-invoice) resource, which represents a
-     *    snapshot for the current period).
+     *    [upcoming invoice](/api-reference/invoice/fetch-upcoming-invoice) resource,
+     *    which represents a snapshot for the current period).
      * 3. Assess how minimums and discounts affect your customers by teasing apart
      *    costs directly as a result of usage, as opposed to minimums and discounts at
      *    the plan and price level.
@@ -126,8 +126,8 @@ export declare class Costs extends APIResource {
     /**
      * This endpoint is used to fetch a day-by-day snapshot of a customer's costs in
      * Orb, calculated by applying pricing information to the underlying usage (see the
-     * [subscription usage endpoint](fetch-subscription-usage.api.mdx) to fetch usage
-     * per metric, in usage units rather than a currency).
+     * [subscription usage endpoint](/api-reference/subscription/fetch-subscription-usage)
+     * to fetch usage per metric, in usage units rather than a currency).
      *
      * This endpoint can be leveraged for internal tooling and to provide a more
      * transparent billing experience for your end users:
@@ -136,8 +136,8 @@ export declare class Costs extends APIResource {
      *    the current billing period.
      * 2. Provide customer visibility into how different services are contributing to
      *    the overall invoice with a per-day timeseries (as compared to the
-     *    [upcoming invoice](fetch-upcoming-invoice) resource, which represents a
-     *    snapshot for the current period).
+     *    [upcoming invoice](/api-reference/invoice/fetch-upcoming-invoice) resource,
+     *    which represents a snapshot for the current period).
      * 3. Assess how minimums and discounts affect your customers by teasing apart
      *    costs directly as a result of usage, as opposed to minimums and discounts at
      *    the plan and price level.
@@ -273,229 +273,8 @@ export declare namespace CostListResponse {
              * 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;
             /**
@@ -541,229 +320,8 @@ export declare namespace CostListByExternalIDResponse {
              * 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;
             /**

package/resources/customers/costs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"costs.d.ts","sourceRoot":"","sources":["../../src/resources/customers/costs.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,SAAS,MAAM,kBAAkB,CAAC;AAE9C,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsHG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,CAAC,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC;IACpC,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC;IAY1F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsHG;IACH,gBAAgB,CACd,kBAAkB,EAAE,MAAM,EAC1B,KAAK,CAAC,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;IAChD,gBAAgB,CACd,kBAAkB,EAAE,MAAM,EAC1B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;CAcjD;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,KAAK,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;CACpC;AAED,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,IAAI;QACnB,eAAe,EAAE,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAE1C;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB,aAAa,EAAE,MAAM,CAAC;QAEtB,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,YAAY;YAC3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAwOG;YACH,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC;YAEvB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC1B;KACF;CACF;AAED,MAAM,WAAW,4BAA4B;IAC3C,IAAI,EAAE,KAAK,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC;CAChD;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,IAAI;QACnB,eAAe,EAAE,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAE1C;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB,aAAa,EAAE,MAAM,CAAC;QAEtB,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,YAAY;YAC3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAwOG;YACH,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC;YAEvB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC1B;KACF;CACF;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;;;OAKG;IACH,SAAS,CAAC,EAAE,UAAU,GAAG,YAAY,GAAG,IAAI,CAAC;CAC9C;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;;;OAKG;IACH,SAAS,CAAC,EAAE,UAAU,GAAG,YAAY,GAAG,IAAI,CAAC;CAC9C;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}
+{"version":3,"file":"costs.d.ts","sourceRoot":"","sources":["../../src/resources/customers/costs.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,SAAS,MAAM,kBAAkB,CAAC;AAE9C,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsHG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,CAAC,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC;IACpC,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC;IAY1F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsHG;IACH,gBAAgB,CACd,kBAAkB,EAAE,MAAM,EAC1B,KAAK,CAAC,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;IAChD,gBAAgB,CACd,kBAAkB,EAAE,MAAM,EAC1B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;CAcjD;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,KAAK,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;CACpC;AAED,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,IAAI;QACnB,eAAe,EAAE,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAE1C;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB,aAAa,EAAE,MAAM,CAAC;QAEtB,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,YAAY;YAC3B;;;;;;;;;;;eAWG;YACH,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC;YAEvB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC1B;KACF;CACF;AAED,MAAM,WAAW,4BAA4B;IAC3C,IAAI,EAAE,KAAK,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC;CAChD;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,IAAI;QACnB,eAAe,EAAE,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAE1C;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB,aAAa,EAAE,MAAM,CAAC;QAEtB,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,YAAY;YAC3B;;;;;;;;;;;eAWG;YACH,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC;YAEvB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC1B;KACF;CACF;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;;;OAKG;IACH,SAAS,CAAC,EAAE,UAAU,GAAG,YAAY,GAAG,IAAI,CAAC;CAC9C;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;;;OAKG;IACH,SAAS,CAAC,EAAE,UAAU,GAAG,YAAY,GAAG,IAAI,CAAC;CAC9C;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}

package/resources/customers/credits/ledger.d.ts

@@ -5,11 +5,11 @@ export declare class Ledger extends APIResource {
     /**
      * The credits ledger provides _auditing_ functionality over Orb's credits system
      * with a list of actions that have taken place to modify a customer's credit
-     * balance. This [paginated endpoint](../reference/pagination) lists these entries,
-     * starting from the most recent ledger entry.
+     * balance. This [paginated endpoint](/api-reference/pagination) lists these
+     * entries, starting from the most recent ledger entry.
      *
      * More details on using Orb's real-time credit feature are
-     * [here](../guides/product-catalog/prepurchase.md).
+     * [here](/product-catalog/prepurchase).
      *
      * There are four major types of modifications to credit balance, detailed below.
      *
@@ -316,11 +316,11 @@ export declare class Ledger extends APIResource {
     /**
      * The credits ledger provides _auditing_ functionality over Orb's credits system
      * with a list of actions that have taken place to modify a customer's credit
-     * balance. This [paginated endpoint](../reference/pagination) lists these entries,
-     * starting from the most recent ledger entry.
+     * balance. This [paginated endpoint](/api-reference/pagination) lists these
+     * entries, starting from the most recent ledger entry.
      *
      * More details on using Orb's real-time credit feature are
-     * [here](../guides/product-catalog/prepurchase.md).
+     * [here](/product-catalog/prepurchase).
      *
      * There are four major types of modifications to credit balance, detailed below.
      *
@@ -404,8 +404,8 @@ export declare class LedgerListResponsesPage extends Page<LedgerListResponse> {
 export declare class LedgerListByExternalIDResponsesPage extends Page<LedgerListByExternalIDResponse> {
 }
 /**
- * The [Credit Ledger Entry resource](/guides/product-catalog/prepurchase) models
- * prepaid credits within Orb.
+ * The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
+ * credits within Orb.
  */
 export type LedgerListResponse = LedgerListResponse.IncrementLedgerEntry | LedgerListResponse.DecrementLedgerEntry | LedgerListResponse.ExpirationChangeLedgerEntry | LedgerListResponse.CreditBlockExpiryLedgerEntry | LedgerListResponse.VoidLedgerEntry | LedgerListResponse.VoidInitiatedLedgerEntry | LedgerListResponse.AmendmentLedgerEntry;
 export declare namespace LedgerListResponse {
@@ -644,8 +644,8 @@ export declare namespace LedgerListResponse {
     }
 }
 /**
- * The [Credit Ledger Entry resource](/guides/product-catalog/prepurchase) models
- * prepaid credits within Orb.
+ * The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
+ * credits within Orb.
  */
 export type LedgerCreateEntryResponse = LedgerCreateEntryResponse.IncrementLedgerEntry | LedgerCreateEntryResponse.DecrementLedgerEntry | LedgerCreateEntryResponse.ExpirationChangeLedgerEntry | LedgerCreateEntryResponse.CreditBlockExpiryLedgerEntry | LedgerCreateEntryResponse.VoidLedgerEntry | LedgerCreateEntryResponse.VoidInitiatedLedgerEntry | LedgerCreateEntryResponse.AmendmentLedgerEntry;
 export declare namespace LedgerCreateEntryResponse {
@@ -884,8 +884,8 @@ export declare namespace LedgerCreateEntryResponse {
     }
 }
 /**
- * The [Credit Ledger Entry resource](/guides/product-catalog/prepurchase) models
- * prepaid credits within Orb.
+ * The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
+ * credits within Orb.
  */
 export type LedgerCreateEntryByExternalIDResponse = LedgerCreateEntryByExternalIDResponse.IncrementLedgerEntry | LedgerCreateEntryByExternalIDResponse.DecrementLedgerEntry | LedgerCreateEntryByExternalIDResponse.ExpirationChangeLedgerEntry | LedgerCreateEntryByExternalIDResponse.CreditBlockExpiryLedgerEntry | LedgerCreateEntryByExternalIDResponse.VoidLedgerEntry | LedgerCreateEntryByExternalIDResponse.VoidInitiatedLedgerEntry | LedgerCreateEntryByExternalIDResponse.AmendmentLedgerEntry;
 export declare namespace LedgerCreateEntryByExternalIDResponse {
@@ -1124,8 +1124,8 @@ export declare namespace LedgerCreateEntryByExternalIDResponse {
     }
 }
 /**
- * The [Credit Ledger Entry resource](/guides/product-catalog/prepurchase) models
- * prepaid credits within Orb.
+ * The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
+ * credits within Orb.
  */
 export type LedgerListByExternalIDResponse = LedgerListByExternalIDResponse.IncrementLedgerEntry | LedgerListByExternalIDResponse.DecrementLedgerEntry | LedgerListByExternalIDResponse.ExpirationChangeLedgerEntry | LedgerListByExternalIDResponse.CreditBlockExpiryLedgerEntry | LedgerListByExternalIDResponse.VoidLedgerEntry | LedgerListByExternalIDResponse.VoidInitiatedLedgerEntry | LedgerListByExternalIDResponse.AmendmentLedgerEntry;
 export declare namespace LedgerListByExternalIDResponse {