orb-billing 6.0.2 → 6.1.0

package/src/resources/alerts.ts

@@ -5,6 +5,7 @@ import * as AlertsAPI from './alerts';
 import * as Shared from './shared';
 import { APIPromise } from '../core/api-promise';
 import { Page, type PageParams, PagePromise } from '../core/pagination';
+import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
@@ -18,15 +19,15 @@ export class Alerts extends APIResource {
   /**
    * This endpoint retrieves an alert by its ID.
    */
-  retrieve(alertId: string, options?: RequestOptions): APIPromise<Alert> {
-    return this._client.get(path`/alerts/${alertId}`, options);
+  retrieve(alertID: string, options?: RequestOptions): APIPromise<Alert> {
+    return this._client.get(path`/alerts/${alertID}`, options);
   }
 
   /**
    * This endpoint updates the thresholds of an alert.
    */
-  update(alertConfigurationId: string, body: AlertUpdateParams, options?: RequestOptions): APIPromise<Alert> {
-    return this._client.put(path`/alerts/${alertConfigurationId}`, { body, ...options });
+  update(alertConfigurationID: string, body: AlertUpdateParams, options?: RequestOptions): APIPromise<Alert> {
+    return this._client.put(path`/alerts/${alertConfigurationID}`, { body, ...options });
   }
 
   /**
@@ -49,6 +50,23 @@ export class Alerts extends APIResource {
     return this._client.getAPIList('/alerts', Page<Alert>, { query, ...options });
   }
 
+  /**
+   * This endpoint trashes a subscription- or customer-scoped alert. The alert is
+   * soft-deleted: it stops firing immediately and no longer appears in fetch or list
+   * responses, while the underlying record is retained internally for audit.
+   *
+   * Plan-level alerts cannot be trashed via the API — disable them instead
+   * (`POST /v1/alerts/{alert_configuration_id}/disable`). Their removal would need
+   * to be unwound from every subscription the alert was propagated to, which isn't
+   * supported yet.
+   */
+  delete(alertConfigurationID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/alerts/${alertConfigurationID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
   /**
    * This endpoint creates a new alert to monitor a customer's credit balance. There
    * are three types of alerts that can be scoped to customers:
@@ -60,11 +78,11 @@ export class Alerts extends APIResource {
    * require thresholds.
    */
   createForCustomer(
-    customerId: string,
+    customerID: string,
     body: AlertCreateForCustomerParams,
     options?: RequestOptions,
   ): APIPromise<Alert> {
-    return this._client.post(path`/alerts/customer_id/${customerId}`, { body, ...options });
+    return this._client.post(path`/alerts/customer_id/${customerID}`, { body, ...options });
   }
 
   /**
@@ -78,11 +96,11 @@ export class Alerts extends APIResource {
    * require thresholds.
    */
   createForExternalCustomer(
-    externalCustomerId: string,
+    externalCustomerID: string,
     body: AlertCreateForExternalCustomerParams,
     options?: RequestOptions,
   ): APIPromise<Alert> {
-    return this._client.post(path`/alerts/external_customer_id/${externalCustomerId}`, { body, ...options });
+    return this._client.post(path`/alerts/external_customer_id/${externalCustomerID}`, { body, ...options });
   }
 
   /**
@@ -99,11 +117,11 @@ export class Alerts extends APIResource {
    * usage or cost conditions met during the current billing cycle.
    */
   createForSubscription(
-    subscriptionId: string,
+    subscriptionID: string,
     body: AlertCreateForSubscriptionParams,
     options?: RequestOptions,
   ): APIPromise<Alert> {
-    return this._client.post(path`/alerts/subscription_id/${subscriptionId}`, { body, ...options });
+    return this._client.post(path`/alerts/subscription_id/${subscriptionID}`, { body, ...options });
   }
 
   /**
@@ -112,12 +130,12 @@ export class Alerts extends APIResource {
    * `subscription_id` is not required for customer or subscription level alerts.
    */
   disable(
-    alertConfigurationId: string,
+    alertConfigurationID: string,
     params: AlertDisableParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<Alert> {
     const { subscription_id } = params ?? {};
-    return this._client.post(path`/alerts/${alertConfigurationId}/disable`, {
+    return this._client.post(path`/alerts/${alertConfigurationID}/disable`, {
       query: { subscription_id },
       ...options,
     });
@@ -129,12 +147,12 @@ export class Alerts extends APIResource {
    * `subscription_id` is not required for customer or subscription level alerts.
    */
   enable(
-    alertConfigurationId: string,
+    alertConfigurationID: string,
     params: AlertEnableParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<Alert> {
     const { subscription_id } = params ?? {};
-    return this._client.post(path`/alerts/${alertConfigurationId}/enable`, {
+    return this._client.post(path`/alerts/${alertConfigurationID}/enable`, {
       query: { subscription_id },
       ...options,
     });

package/src/resources/beta/beta.ts

@@ -26,11 +26,11 @@ export class Beta extends APIResource {
    * This endpoint allows the creation of a new plan version for an existing plan.
    */
   createPlanVersion(
-    planId: string,
+    planID: string,
     body: BetaCreatePlanVersionParams,
     options?: RequestOptions,
   ): APIPromise<PlanVersion> {
-    return this._client.post(path`/plans/${planId}/versions`, { body, ...options });
+    return this._client.post(path`/plans/${planID}/versions`, { body, ...options });
   }
 
   /**
@@ -42,19 +42,19 @@ export class Beta extends APIResource {
     params: BetaFetchPlanVersionParams,
     options?: RequestOptions,
   ): APIPromise<PlanVersion> {
-    const { plan_id: planId } = params;
-    return this._client.get(path`/plans/${planId}/versions/${version}`, options);
+    const { plan_id } = params;
+    return this._client.get(path`/plans/${plan_id}/versions/${version}`, options);
   }
 
   /**
    * This endpoint allows setting the default version of a plan.
    */
   setDefaultPlanVersion(
-    planId: string,
+    planID: string,
     body: BetaSetDefaultPlanVersionParams,
     options?: RequestOptions,
   ): APIPromise<PlansAPI.Plan> {
-    return this._client.post(path`/plans/${planId}/set_default_version`, { body, ...options });
+    return this._client.post(path`/plans/${planID}/set_default_version`, { body, ...options });
   }
 }
 

package/src/resources/beta/external-plan-id.ts

@@ -18,11 +18,11 @@ export class ExternalPlanID extends APIResource {
    * This endpoint allows the creation of a new plan version for an existing plan.
    */
   createPlanVersion(
-    externalPlanId: string,
+    externalPlanID: string,
     body: ExternalPlanIDCreatePlanVersionParams,
     options?: RequestOptions,
   ): APIPromise<BetaAPI.PlanVersion> {
-    return this._client.post(path`/plans/external_plan_id/${externalPlanId}/versions`, { body, ...options });
+    return this._client.post(path`/plans/external_plan_id/${externalPlanID}/versions`, { body, ...options });
   }
 
   /**
@@ -34,19 +34,19 @@ export class ExternalPlanID extends APIResource {
     params: ExternalPlanIDFetchPlanVersionParams,
     options?: RequestOptions,
   ): APIPromise<BetaAPI.PlanVersion> {
-    const { external_plan_id: externalPlanId } = params;
-    return this._client.get(path`/plans/external_plan_id/${externalPlanId}/versions/${version}`, options);
+    const { external_plan_id } = params;
+    return this._client.get(path`/plans/external_plan_id/${external_plan_id}/versions/${version}`, options);
   }
 
   /**
    * This endpoint allows setting the default version of a plan.
    */
   setDefaultPlanVersion(
-    externalPlanId: string,
+    externalPlanID: string,
     body: ExternalPlanIDSetDefaultPlanVersionParams,
     options?: RequestOptions,
   ): APIPromise<PlansAPI.Plan> {
-    return this._client.post(path`/plans/external_plan_id/${externalPlanId}/set_default_version`, {
+    return this._client.post(path`/plans/external_plan_id/${externalPlanID}/set_default_version`, {
       body,
       ...options,
     });

package/src/resources/coupons/coupons.ts

@@ -66,8 +66,8 @@ export class Coupons extends APIResource {
    * const coupon = await client.coupons.archive('coupon_id');
    * ```
    */
-  archive(couponId: string, options?: RequestOptions): APIPromise<Coupon> {
-    return this._client.post(path`/coupons/${couponId}/archive`, options);
+  archive(couponID: string, options?: RequestOptions): APIPromise<Coupon> {
+    return this._client.post(path`/coupons/${couponID}/archive`, options);
   }
 
   /**
@@ -80,8 +80,8 @@ export class Coupons extends APIResource {
    * const coupon = await client.coupons.fetch('coupon_id');
    * ```
    */
-  fetch(couponId: string, options?: RequestOptions): APIPromise<Coupon> {
-    return this._client.get(path`/coupons/${couponId}`, options);
+  fetch(couponID: string, options?: RequestOptions): APIPromise<Coupon> {
+    return this._client.get(path`/coupons/${couponID}`, options);
   }
 }
 

package/src/resources/coupons/subscriptions.ts

@@ -28,12 +28,12 @@ export class Subscriptions extends APIResource {
    * ```
    */
   list(
-    couponId: string,
+    couponID: string,
     query: SubscriptionListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<SubscriptionsPage, SubscriptionsAPI.Subscription> {
     return this._client.getAPIList(
-      path`/coupons/${couponId}/subscriptions`,
+      path`/coupons/${couponID}/subscriptions`,
       Page<SubscriptionsAPI.Subscription>,
       { query, ...options },
     );

package/src/resources/credit-blocks.ts

@@ -14,8 +14,8 @@ export class CreditBlocks extends APIResource {
   /**
    * This endpoint returns a credit block identified by its block_id.
    */
-  retrieve(blockId: string, options?: RequestOptions): APIPromise<CreditBlockRetrieveResponse> {
-    return this._client.get(path`/credit_blocks/${blockId}`, options);
+  retrieve(blockID: string, options?: RequestOptions): APIPromise<CreditBlockRetrieveResponse> {
+    return this._client.get(path`/credit_blocks/${blockID}`, options);
   }
 
   /**
@@ -35,8 +35,8 @@ export class CreditBlocks extends APIResource {
    * reflect the state as if credits from the deleted block were never applied.
    * </Note>
    */
-  delete(blockId: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/credit_blocks/${blockId}`, {
+  delete(blockID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/credit_blocks/${blockID}`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -61,8 +61,8 @@ export class CreditBlocks extends APIResource {
    * future releases. Please contact support before building production integrations
    * against this endpoint.**
    */
-  listInvoices(blockId: string, options?: RequestOptions): APIPromise<CreditBlockListInvoicesResponse> {
-    return this._client.get(path`/credit_blocks/${blockId}/invoices`, options);
+  listInvoices(blockID: string, options?: RequestOptions): APIPromise<CreditBlockListInvoicesResponse> {
+    return this._client.get(path`/credit_blocks/${blockID}/invoices`, options);
   }
 }
 

package/src/resources/credit-notes.ts

@@ -90,8 +90,8 @@ export class CreditNotes extends APIResource {
    * );
    * ```
    */
-  fetch(creditNoteId: string, options?: RequestOptions): APIPromise<Shared.CreditNote> {
-    return this._client.get(path`/credit_notes/${creditNoteId}`, options);
+  fetch(creditNoteID: string, options?: RequestOptions): APIPromise<Shared.CreditNote> {
+    return this._client.get(path`/credit_notes/${creditNoteID}`, options);
   }
 }
 

package/src/resources/customers/balance-transactions.ts

@@ -29,11 +29,11 @@ export class BalanceTransactions extends APIResource {
    * returns back the newly created transaction.
    */
   create(
-    customerId: string,
+    customerID: string,
     body: BalanceTransactionCreateParams,
     options?: RequestOptions,
   ): APIPromise<BalanceTransactionCreateResponse> {
-    return this._client.post(path`/customers/${customerId}/balance_transactions`, { body, ...options });
+    return this._client.post(path`/customers/${customerID}/balance_transactions`, { body, ...options });
   }
 
   /**
@@ -60,12 +60,12 @@ export class BalanceTransactions extends APIResource {
    * all adjustments and invoice applications.
    */
   list(
-    customerId: string,
+    customerID: string,
     query: BalanceTransactionListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<BalanceTransactionListResponsesPage, BalanceTransactionListResponse> {
     return this._client.getAPIList(
-      path`/customers/${customerId}/balance_transactions`,
+      path`/customers/${customerID}/balance_transactions`,
       Page<BalanceTransactionListResponse>,
       { query, ...options },
     );

package/src/resources/customers/costs.ts

@@ -143,11 +143,11 @@ export class Costs extends APIResource {
    * `grouping_value` and `secondary_grouping_value` available.
    */
   list(
-    customerId: string,
+    customerID: string,
     query: CostListParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<CostListResponse> {
-    return this._client.get(path`/customers/${customerId}/costs`, { query, ...options });
+    return this._client.get(path`/customers/${customerID}/costs`, { query, ...options });
   }
 
   /**
@@ -270,11 +270,11 @@ export class Costs extends APIResource {
    * `grouping_value` and `secondary_grouping_value` available.
    */
   listByExternalID(
-    externalCustomerId: string,
+    externalCustomerID: string,
     query: CostListByExternalIDParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<CostListByExternalIDResponse> {
-    return this._client.get(path`/customers/external_customer_id/${externalCustomerId}/costs`, {
+    return this._client.get(path`/customers/external_customer_id/${externalCustomerID}/costs`, {
       query,
       ...options,
     });

package/src/resources/customers/credits/credits.ts

@@ -67,11 +67,11 @@ export class Credits extends APIResource {
    * becomes effective, which may differ from creation time for backdated credits.
    */
   list(
-    customerId: string,
+    customerID: string,
     query: CreditListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<CreditListResponsesPage, CreditListResponse> {
-    return this._client.getAPIList(path`/customers/${customerId}/credits`, Page<CreditListResponse>, {
+    return this._client.getAPIList(path`/customers/${customerID}/credits`, Page<CreditListResponse>, {
       query,
       ...options,
     });
@@ -92,12 +92,12 @@ export class Credits extends APIResource {
    * becomes effective, which may differ from creation time for backdated credits.
    */
   listByExternalID(
-    externalCustomerId: string,
+    externalCustomerID: string,
     query: CreditListByExternalIDParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<CreditListByExternalIDResponsesPage, CreditListByExternalIDResponse> {
     return this._client.getAPIList(
-      path`/customers/external_customer_id/${externalCustomerId}/credits`,
+      path`/customers/external_customer_id/${externalCustomerID}/credits`,
       Page<CreditListByExternalIDResponse>,
       { query, ...options },
     );

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

@@ -93,11 +93,11 @@ export class Ledger extends APIResource {
    * entry will be added to the ledger to indicate the adjustment of credits.
    */
   list(
-    customerId: string,
+    customerID: string,
     query: LedgerListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<LedgerListResponsesPage, LedgerListResponse> {
-    return this._client.getAPIList(path`/customers/${customerId}/credits/ledger`, Page<LedgerListResponse>, {
+    return this._client.getAPIList(path`/customers/${customerID}/credits/ledger`, Page<LedgerListResponse>, {
       query,
       ...options,
     });
@@ -230,11 +230,11 @@ export class Ledger extends APIResource {
    * return to the customer, up to the block's initial balance.
    */
   createEntry(
-    customerId: string,
+    customerID: string,
     body: LedgerCreateEntryParams,
     options?: RequestOptions,
   ): APIPromise<LedgerCreateEntryResponse> {
-    return this._client.post(path`/customers/${customerId}/credits/ledger_entry`, { body, ...options });
+    return this._client.post(path`/customers/${customerID}/credits/ledger_entry`, { body, ...options });
   }
 
   /**
@@ -364,12 +364,12 @@ export class Ledger extends APIResource {
    * return to the customer, up to the block's initial balance.
    */
   createEntryByExternalID(
-    externalCustomerId: string,
+    externalCustomerID: string,
     body: LedgerCreateEntryByExternalIDParams,
     options?: RequestOptions,
   ): APIPromise<LedgerCreateEntryByExternalIDResponse> {
     return this._client.post(
-      path`/customers/external_customer_id/${externalCustomerId}/credits/ledger_entry`,
+      path`/customers/external_customer_id/${externalCustomerID}/credits/ledger_entry`,
       { body, ...options },
     );
   }
@@ -456,12 +456,12 @@ export class Ledger extends APIResource {
    * entry will be added to the ledger to indicate the adjustment of credits.
    */
   listByExternalID(
-    externalCustomerId: string,
+    externalCustomerID: string,
     query: LedgerListByExternalIDParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<LedgerListByExternalIDResponsesPage, LedgerListByExternalIDResponse> {
     return this._client.getAPIList(
-      path`/customers/external_customer_id/${externalCustomerId}/credits/ledger`,
+      path`/customers/external_customer_id/${externalCustomerID}/credits/ledger`,
       Page<LedgerListByExternalIDResponse>,
       { query, ...options },
     );

package/src/resources/customers/credits/top-ups.ts

@@ -21,22 +21,22 @@ export class TopUps extends APIResource {
    * top-up will be replaced.
    */
   create(
-    customerId: string,
+    customerID: string,
     body: TopUpCreateParams,
     options?: RequestOptions,
   ): APIPromise<TopUpCreateResponse> {
-    return this._client.post(path`/customers/${customerId}/credits/top_ups`, { body, ...options });
+    return this._client.post(path`/customers/${customerID}/credits/top_ups`, { body, ...options });
   }
 
   /**
    * List top-ups
    */
   list(
-    customerId: string,
+    customerID: string,
     query: TopUpListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<TopUpListResponsesPage, TopUpListResponse> {
-    return this._client.getAPIList(path`/customers/${customerId}/credits/top_ups`, Page<TopUpListResponse>, {
+    return this._client.getAPIList(path`/customers/${customerID}/credits/top_ups`, Page<TopUpListResponse>, {
       query,
       ...options,
     });
@@ -46,9 +46,9 @@ export class TopUps extends APIResource {
    * This deactivates the top-up and voids any invoices associated with pending
    * credit blocks purchased through the top-up.
    */
-  delete(topUpId: string, params: TopUpDeleteParams, options?: RequestOptions): APIPromise<void> {
-    const { customer_id: customerId } = params;
-    return this._client.delete(path`/customers/${customerId}/credits/top_ups/${topUpId}`, {
+  delete(topUpID: string, params: TopUpDeleteParams, options?: RequestOptions): APIPromise<void> {
+    const { customer_id } = params;
+    return this._client.delete(path`/customers/${customer_id}/credits/top_ups/${topUpID}`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -64,11 +64,11 @@ export class TopUps extends APIResource {
    * top-up will be replaced.
    */
   createByExternalID(
-    externalCustomerId: string,
+    externalCustomerID: string,
     body: TopUpCreateByExternalIDParams,
     options?: RequestOptions,
   ): APIPromise<TopUpCreateByExternalIDResponse> {
-    return this._client.post(path`/customers/external_customer_id/${externalCustomerId}/credits/top_ups`, {
+    return this._client.post(path`/customers/external_customer_id/${externalCustomerID}/credits/top_ups`, {
       body,
       ...options,
     });
@@ -79,13 +79,13 @@ export class TopUps extends APIResource {
    * credit blocks purchased through the top-up.
    */
   deleteByExternalID(
-    topUpId: string,
+    topUpID: string,
     params: TopUpDeleteByExternalIDParams,
     options?: RequestOptions,
   ): APIPromise<void> {
-    const { external_customer_id: externalCustomerId } = params;
+    const { external_customer_id } = params;
     return this._client.delete(
-      path`/customers/external_customer_id/${externalCustomerId}/credits/top_ups/${topUpId}`,
+      path`/customers/external_customer_id/${external_customer_id}/credits/top_ups/${topUpID}`,
       { ...options, headers: buildHeaders([{ Accept: '*/*' }, options?.headers]) },
     );
   }
@@ -94,12 +94,12 @@ export class TopUps extends APIResource {
    * List top-ups by external ID
    */
   listByExternalID(
-    externalCustomerId: string,
+    externalCustomerID: string,
     query: TopUpListByExternalIDParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<TopUpListByExternalIDResponsesPage, TopUpListByExternalIDResponse> {
     return this._client.getAPIList(
-      path`/customers/external_customer_id/${externalCustomerId}/credits/top_ups`,
+      path`/customers/external_customer_id/${externalCustomerID}/credits/top_ups`,
       Page<TopUpListByExternalIDResponse>,
       { query, ...options },
     );