@stigg/typescript 0.1.0-beta.55 → 0.1.0-beta.56

package/src/resources/v1/subscriptions/subscriptions.ts

@@ -53,7 +53,13 @@ export class Subscriptions extends APIResource {
 
   /**
    * Updates an active subscription's properties including billing period, add-ons,
-   * unit quantities, and discounts.
+   * unit quantities, and discounts. This is a partial update — only the fields
+   * present in the request body change. Object fields such as `metadata` are
+   * replaced wholesale rather than merged, and list fields such as `addons` and
+   * `priceOverrides` must be sent in full: any existing item that isn't included in
+   * the array is removed from the subscription. Changes classified as a downgrade
+   * may be scheduled for the end of the current billing period instead of applying
+   * immediately, depending on your update scheduling configuration.
    */
   update(id: string, params: SubscriptionUpdateParams, options?: RequestOptions): APIPromise<Subscription> {
     const { 'X-ACCOUNT-ID': xAccountID, 'X-ENVIRONMENT-ID': xEnvironmentID, ...body } = params;
@@ -112,8 +118,10 @@ export class Subscriptions extends APIResource {
   }
 
   /**
-   * Delegates the payment responsibility of a subscription to a different customer.
-   * The delegated customer will be billed for this subscription.
+   * Delegates a subscription to a different customer, who becomes responsible for
+   * managing it. The original customer remains the paying customer for this
+   * subscription, unless payment was already delegated to the target customer, in
+   * which case the target customer becomes the paying customer as well.
    */
   delegate(
     id: string,
@@ -377,7 +385,8 @@ export namespace Subscription {
     latestInvoice?: Data.LatestInvoice | null;
 
     /**
-     * Additional metadata for the subscription
+     * Additional metadata for the subscription, stored as an arbitrary flat key-value
+     * object.
      */
     metadata?: { [key: string]: string };
 
@@ -863,7 +872,10 @@ export namespace Subscription {
       baseCharge?: boolean;
 
       /**
-       * The billing country code of the price
+       * ISO 3166-1 alpha-2 country code this price applies to, or "eu" for the European
+       * Union group you map countries into. Omit for the default price shown to all
+       * countries; set one or more country-specific price periods on the same currency
+       * to localize the amount by billing country.
        */
       billingCountryCode?: string;
 
@@ -1438,7 +1450,8 @@ export interface SubscriptionListResponse {
   latestInvoice?: SubscriptionListResponse.LatestInvoice | null;
 
   /**
-   * Additional metadata for the subscription
+   * Additional metadata for the subscription, stored as an arbitrary flat key-value
+   * object.
    */
   metadata?: { [key: string]: string };
 
@@ -1924,7 +1937,10 @@ export namespace SubscriptionListResponse {
     baseCharge?: boolean;
 
     /**
-     * The billing country code of the price
+     * ISO 3166-1 alpha-2 country code this price applies to, or "eu" for the European
+     * Union group you map countries into. Omit for the default price shown to all
+     * countries; set one or more country-specific price periods on the same currency
+     * to localize the amount by billing country.
      */
     billingCountryCode?: string;
 
@@ -2426,7 +2442,12 @@ export namespace SubscriptionPreviewResponse {
     hasScheduledUpdates?: boolean;
 
     /**
-     * Whether this is a downgrade
+     * Whether this change is classified as a downgrade. Stigg determines this by
+     * ranking the target plan against the customer's current plan — primarily by
+     * calculated price (or by plan parent/child inheritance, when your catalog uses
+     * it) — rather than by a manually assigned plan order. Downgrades can be scheduled
+     * to take effect at the end of the current billing period instead of immediately,
+     * depending on your update scheduling configuration.
      */
     isPlanDowngrade?: boolean;
 
@@ -3090,7 +3111,8 @@ export namespace SubscriptionProvisionResponse {
       latestInvoice?: Subscription.LatestInvoice | null;
 
       /**
-       * Additional metadata for the subscription
+       * Additional metadata for the subscription, stored as an arbitrary flat key-value
+       * object.
        */
       metadata?: { [key: string]: string };
 
@@ -3576,7 +3598,10 @@ export namespace SubscriptionProvisionResponse {
         baseCharge?: boolean;
 
         /**
-         * The billing country code of the price
+         * ISO 3166-1 alpha-2 country code this price applies to, or "eu" for the European
+         * Union group you map countries into. Omit for the default price shown to all
+         * countries; set one or more country-specific price periods on the same currency
+         * to localize the amount by billing country.
          */
         billingCountryCode?: string;
 
@@ -4095,7 +4120,8 @@ export interface SubscriptionUpdateParams {
   entitlements?: Array<SubscriptionUpdateParams.Feature | SubscriptionUpdateParams.Credit>;
 
   /**
-   * Body param: Additional metadata for the subscription
+   * Body param: Additional metadata for the subscription, stored as an arbitrary
+   * flat key-value object.
    */
   metadata?: { [key: string]: string };
 
@@ -4347,7 +4373,8 @@ export namespace SubscriptionUpdateParams {
     isInvoicePaid?: boolean;
 
     /**
-     * Additional metadata for the subscription
+     * Additional metadata for the subscription, stored as an arbitrary flat key-value
+     * object.
      */
     metadata?: { [key: string]: string };
 
@@ -4539,6 +4566,11 @@ export namespace SubscriptionUpdateParams {
      * SubscriptionCreditEntitlementRequest
      */
     type: 'CREDIT';
+
+    /**
+     * Whether the credit balance is a soft limit
+     */
+    hasSoftLimit?: boolean;
   }
 
   /**
@@ -4933,10 +4965,10 @@ export interface SubscriptionCancelParams {
 
 export interface SubscriptionDelegateParams {
   /**
-   * Body param: The unique identifier of the customer who will assume payment
-   * responsibility for this subscription. This customer must already exist in your
-   * Stigg account and have a valid payment method if the subscription requires
-   * payment.
+   * Body param: The unique identifier of the customer who will manage this
+   * subscription going forward. This customer must already exist in your Stigg
+   * account. The paying customer for the subscription does not change as a result of
+   * this request.
    */
   targetCustomerId: string;
 
@@ -5016,7 +5048,8 @@ export namespace SubscriptionImportParams {
     endDate?: string | null;
 
     /**
-     * Additional metadata for the subscription
+     * Additional metadata for the subscription, stored as an arbitrary flat key-value
+     * object.
      */
     metadata?: { [key: string]: string };
 
@@ -5117,7 +5150,8 @@ export interface SubscriptionPreviewParams {
   billableFeatures?: Array<SubscriptionPreviewParams.BillableFeature>;
 
   /**
-   * Body param: ISO 3166-1 country code for localization
+   * Body param: Country code selecting a localized price, or "eu" for the European
+   * Union group you map countries into; the default price applies when none matches
    */
   billingCountryCode?: string;
 
@@ -5587,7 +5621,9 @@ export interface SubscriptionProvisionParams {
   awaitPaymentConfirmation?: boolean;
 
   /**
-   * Body param: The ISO 3166-1 alpha-2 country code for billing
+   * Body param: The country code used to select a localized price, or "eu" for the
+   * European Union group you map countries into, falling back to the default price
+   * when none matches
    */
   billingCountryCode?: string | null;
 
@@ -5637,7 +5673,8 @@ export interface SubscriptionProvisionParams {
   entitlements?: Array<SubscriptionProvisionParams.Feature | SubscriptionProvisionParams.Credit>;
 
   /**
-   * Body param: Additional metadata for the subscription
+   * Body param: Additional metadata for the subscription, stored as an arbitrary
+   * flat key-value object.
    */
   metadata?: { [key: string]: string };
 
@@ -5955,7 +5992,8 @@ export namespace SubscriptionProvisionParams {
     isInvoicePaid?: boolean;
 
     /**
-     * Additional metadata for the subscription
+     * Additional metadata for the subscription, stored as an arbitrary flat key-value
+     * object.
      */
     metadata?: { [key: string]: string };
 
@@ -6200,6 +6238,11 @@ export namespace SubscriptionProvisionParams {
      * SubscriptionCreditEntitlementRequest
      */
     type: 'CREDIT';
+
+    /**
+     * Whether the credit balance is a soft limit
+     */
+    hasSoftLimit?: boolean;
   }
 
   /**
@@ -6350,7 +6393,10 @@ export namespace SubscriptionProvisionParams {
     baseCharge?: boolean;
 
     /**
-     * The billing country code of the price
+     * ISO 3166-1 alpha-2 country code this price applies to, or "eu" for the European
+     * Union group you map countries into. Omit for the default price shown to all
+     * countries; set one or more country-specific price periods on the same currency
+     * to localize the amount by billing country.
      */
     billingCountryCode?: string;
 

package/src/resources/v1/usage.ts

@@ -310,7 +310,10 @@ export namespace UsageReportResponse {
     nextResetDate?: string | null;
 
     /**
-     * Resource id
+     * The customer resource this usage applies to. Optional — only required if the
+     * customer has multiple resources (for example, one subscription per workspace or
+     * site) and usage needs to be tracked separately per resource; omit it to report
+     * usage at the customer level.
      */
     resourceId?: string | null;
 
@@ -385,7 +388,10 @@ export interface UsageEstimateParams {
   featureId: string;
 
   /**
-   * Body param: The value to report for usage
+   * Body param: The value to report for usage. Must be a whole number — the REST API
+   * does not accept fractional (float) usage values; scale up (e.g. report cents
+   * instead of dollars, or milliseconds instead of seconds) if you need sub-unit
+   * precision.
    */
   value: number;
 
@@ -395,12 +401,17 @@ export interface UsageEstimateParams {
   dimensions?: { [key: string]: string | number | boolean };
 
   /**
-   * Body param: Resource id
+   * Body param: The customer resource this usage applies to. Optional — only
+   * required if the customer has multiple resources (for example, one subscription
+   * per workspace or site) and usage needs to be tracked separately per resource;
+   * omit it to report usage at the customer level.
    */
   resourceId?: string | null;
 
   /**
-   * Body param: The method by which the usage value should be updated
+   * Body param: How the reported value is applied: DELTA (default) adds it to the
+   * feature's current usage; SET treats it as the new absolute usage total, and
+   * Stigg computes the delta internally.
    */
   updateBehavior?: 'DELTA' | 'SET';
 
@@ -440,7 +451,10 @@ export interface UsageHistoryParams {
   groupBy?: string;
 
   /**
-   * Query param: Resource id
+   * Query param: The customer resource this usage applies to. Optional — only
+   * required if the customer has multiple resources (for example, one subscription
+   * per workspace or site) and usage needs to be tracked separately per resource;
+   * omit it to report usage at the customer level.
    */
   resourceId?: string | null;
 
@@ -494,7 +508,9 @@ export namespace UsageReportParams {
     featureId: string;
 
     /**
-     * The value to report for usage
+     * The value to report for usage. Must be a whole number — the REST API does not
+     * accept fractional (float) usage values; scale up (e.g. report cents instead of
+     * dollars, or milliseconds instead of seconds) if you need sub-unit precision.
      */
     value: number;
 
@@ -509,17 +525,24 @@ export namespace UsageReportParams {
     dimensions?: { [key: string]: string | number | boolean };
 
     /**
-     * Idempotency key
+     * A key you provide to safely retry the same usage report without double-counting
+     * it. Reports with a previously-seen idempotency key are deduplicated for 7 days;
+     * after that window a retry is treated as new usage.
      */
     idempotencyKey?: string;
 
     /**
-     * Resource id
+     * The customer resource this usage applies to. Optional — only required if the
+     * customer has multiple resources (for example, one subscription per workspace or
+     * site) and usage needs to be tracked separately per resource; omit it to report
+     * usage at the customer level.
      */
     resourceId?: string | null;
 
     /**
-     * The method by which the usage value should be updated
+     * How the reported value is applied: DELTA (default) adds it to the feature's
+     * current usage; SET treats it as the new absolute usage total, and Stigg computes
+     * the delta internally.
      */
     updateBehavior?: 'DELTA' | 'SET';
   }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.1.0-beta.55'; // x-release-please-version
+export const VERSION = '0.1.0-beta.56'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.1.0-beta.55";
+export declare const VERSION = "0.1.0-beta.56";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.1.0-beta.55";
+export declare const VERSION = "0.1.0-beta.56";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.1.0-beta.55'; // x-release-please-version
+exports.VERSION = '0.1.0-beta.56'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.1.0-beta.55'; // x-release-please-version
+export const VERSION = '0.1.0-beta.56'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map