orb-billing 1.33.1 → 1.34.1

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

@@ -489,6 +489,8 @@ export namespace LedgerListResponse {
 
     credit_block: IncrementLedgerEntry.CreditBlock;
 
+    currency: string;
+
     customer: IncrementLedgerEntry.Customer;
 
     description: string | null;
@@ -537,6 +539,8 @@ export namespace LedgerListResponse {
 
     credit_block: DecrementLedgerEntry.CreditBlock;
 
+    currency: string;
+
     customer: DecrementLedgerEntry.Customer;
 
     description: string | null;
@@ -591,6 +595,8 @@ export namespace LedgerListResponse {
 
     credit_block: ExpirationChangeLedgerEntry.CreditBlock;
 
+    currency: string;
+
     customer: ExpirationChangeLedgerEntry.Customer;
 
     description: string | null;
@@ -641,6 +647,8 @@ export namespace LedgerListResponse {
 
     credit_block: CreditBlockExpiryLedgerEntry.CreditBlock;
 
+    currency: string;
+
     customer: CreditBlockExpiryLedgerEntry.Customer;
 
     description: string | null;
@@ -689,6 +697,8 @@ export namespace LedgerListResponse {
 
     credit_block: VoidLedgerEntry.CreditBlock;
 
+    currency: string;
+
     customer: VoidLedgerEntry.Customer;
 
     description: string | null;
@@ -741,6 +751,8 @@ export namespace LedgerListResponse {
 
     credit_block: VoidInitiatedLedgerEntry.CreditBlock;
 
+    currency: string;
+
     customer: VoidInitiatedLedgerEntry.Customer;
 
     description: string | null;
@@ -795,6 +807,8 @@ export namespace LedgerListResponse {
 
     credit_block: AmendmentLedgerEntry.CreditBlock;
 
+    currency: string;
+
     customer: AmendmentLedgerEntry.Customer;
 
     description: string | null;
@@ -858,6 +872,8 @@ export namespace LedgerCreateEntryResponse {
 
     credit_block: IncrementLedgerEntry.CreditBlock;
 
+    currency: string;
+
     customer: IncrementLedgerEntry.Customer;
 
     description: string | null;
@@ -906,6 +922,8 @@ export namespace LedgerCreateEntryResponse {
 
     credit_block: DecrementLedgerEntry.CreditBlock;
 
+    currency: string;
+
     customer: DecrementLedgerEntry.Customer;
 
     description: string | null;
@@ -960,6 +978,8 @@ export namespace LedgerCreateEntryResponse {
 
     credit_block: ExpirationChangeLedgerEntry.CreditBlock;
 
+    currency: string;
+
     customer: ExpirationChangeLedgerEntry.Customer;
 
     description: string | null;
@@ -1010,6 +1030,8 @@ export namespace LedgerCreateEntryResponse {
 
     credit_block: CreditBlockExpiryLedgerEntry.CreditBlock;
 
+    currency: string;
+
     customer: CreditBlockExpiryLedgerEntry.Customer;
 
     description: string | null;
@@ -1058,6 +1080,8 @@ export namespace LedgerCreateEntryResponse {
 
     credit_block: VoidLedgerEntry.CreditBlock;
 
+    currency: string;
+
     customer: VoidLedgerEntry.Customer;
 
     description: string | null;
@@ -1110,6 +1134,8 @@ export namespace LedgerCreateEntryResponse {
 
     credit_block: VoidInitiatedLedgerEntry.CreditBlock;
 
+    currency: string;
+
     customer: VoidInitiatedLedgerEntry.Customer;
 
     description: string | null;
@@ -1164,6 +1190,8 @@ export namespace LedgerCreateEntryResponse {
 
     credit_block: AmendmentLedgerEntry.CreditBlock;
 
+    currency: string;
+
     customer: AmendmentLedgerEntry.Customer;
 
     description: string | null;
@@ -1227,6 +1255,8 @@ export namespace LedgerCreateEntryByExternalIDResponse {
 
     credit_block: IncrementLedgerEntry.CreditBlock;
 
+    currency: string;
+
     customer: IncrementLedgerEntry.Customer;
 
     description: string | null;
@@ -1275,6 +1305,8 @@ export namespace LedgerCreateEntryByExternalIDResponse {
 
     credit_block: DecrementLedgerEntry.CreditBlock;
 
+    currency: string;
+
     customer: DecrementLedgerEntry.Customer;
 
     description: string | null;
@@ -1329,6 +1361,8 @@ export namespace LedgerCreateEntryByExternalIDResponse {
 
     credit_block: ExpirationChangeLedgerEntry.CreditBlock;
 
+    currency: string;
+
     customer: ExpirationChangeLedgerEntry.Customer;
 
     description: string | null;
@@ -1379,6 +1413,8 @@ export namespace LedgerCreateEntryByExternalIDResponse {
 
     credit_block: CreditBlockExpiryLedgerEntry.CreditBlock;
 
+    currency: string;
+
     customer: CreditBlockExpiryLedgerEntry.Customer;
 
     description: string | null;
@@ -1427,6 +1463,8 @@ export namespace LedgerCreateEntryByExternalIDResponse {
 
     credit_block: VoidLedgerEntry.CreditBlock;
 
+    currency: string;
+
     customer: VoidLedgerEntry.Customer;
 
     description: string | null;
@@ -1479,6 +1517,8 @@ export namespace LedgerCreateEntryByExternalIDResponse {
 
     credit_block: VoidInitiatedLedgerEntry.CreditBlock;
 
+    currency: string;
+
     customer: VoidInitiatedLedgerEntry.Customer;
 
     description: string | null;
@@ -1533,6 +1573,8 @@ export namespace LedgerCreateEntryByExternalIDResponse {
 
     credit_block: AmendmentLedgerEntry.CreditBlock;
 
+    currency: string;
+
     customer: AmendmentLedgerEntry.Customer;
 
     description: string | null;
@@ -1596,6 +1638,8 @@ export namespace LedgerListByExternalIDResponse {
 
     credit_block: IncrementLedgerEntry.CreditBlock;
 
+    currency: string;
+
     customer: IncrementLedgerEntry.Customer;
 
     description: string | null;
@@ -1644,6 +1688,8 @@ export namespace LedgerListByExternalIDResponse {
 
     credit_block: DecrementLedgerEntry.CreditBlock;
 
+    currency: string;
+
     customer: DecrementLedgerEntry.Customer;
 
     description: string | null;
@@ -1698,6 +1744,8 @@ export namespace LedgerListByExternalIDResponse {
 
     credit_block: ExpirationChangeLedgerEntry.CreditBlock;
 
+    currency: string;
+
     customer: ExpirationChangeLedgerEntry.Customer;
 
     description: string | null;
@@ -1748,6 +1796,8 @@ export namespace LedgerListByExternalIDResponse {
 
     credit_block: CreditBlockExpiryLedgerEntry.CreditBlock;
 
+    currency: string;
+
     customer: CreditBlockExpiryLedgerEntry.Customer;
 
     description: string | null;
@@ -1796,6 +1846,8 @@ export namespace LedgerListByExternalIDResponse {
 
     credit_block: VoidLedgerEntry.CreditBlock;
 
+    currency: string;
+
     customer: VoidLedgerEntry.Customer;
 
     description: string | null;
@@ -1848,6 +1900,8 @@ export namespace LedgerListByExternalIDResponse {
 
     credit_block: VoidInitiatedLedgerEntry.CreditBlock;
 
+    currency: string;
+
     customer: VoidInitiatedLedgerEntry.Customer;
 
     description: string | null;
@@ -1902,6 +1956,8 @@ export namespace LedgerListByExternalIDResponse {
 
     credit_block: AmendmentLedgerEntry.CreditBlock;
 
+    currency: string;
+
     customer: AmendmentLedgerEntry.Customer;
 
     description: string | null;
@@ -1951,6 +2007,9 @@ export interface LedgerListParams extends PageParams {
 
   'created_at[lte]'?: string | null;
 
+  /**
+   * The ledger currency or custom pricing unit to use.
+   */
   currency?: string | null;
 
   entry_status?: 'committed' | 'pending' | null;
@@ -1985,6 +2044,12 @@ export namespace LedgerCreateEntryParams {
 
     entry_type: 'increment';
 
+    /**
+     * The currency or custom pricing unit to use for this ledger entry. If this is a
+     * real-world currency, it must match the customer's invoicing currency.
+     */
+    currency?: string | null;
+
     /**
      * Optional metadata that can be specified when adding ledger results via the API.
      * For example, this can be used to note an increment refers to trial credits, or
@@ -2063,6 +2128,12 @@ export namespace LedgerCreateEntryParams {
 
     entry_type: 'decrement';
 
+    /**
+     * The currency or custom pricing unit to use for this ledger entry. If this is a
+     * real-world currency, it must match the customer's invoicing currency.
+     */
+    currency?: string | null;
+
     /**
      * Optional metadata that can be specified when adding ledger results via the API.
      * For example, this can be used to note an increment refers to trial credits, or
@@ -2106,6 +2177,12 @@ export namespace LedgerCreateEntryParams {
      */
     block_id?: string | null;
 
+    /**
+     * The currency or custom pricing unit to use for this ledger entry. If this is a
+     * real-world currency, it must match the customer's invoicing currency.
+     */
+    currency?: string | null;
+
     /**
      * Optional metadata that can be specified when adding ledger results via the API.
      * For example, this can be used to note an increment refers to trial credits, or
@@ -2135,6 +2212,12 @@ export namespace LedgerCreateEntryParams {
 
     entry_type: 'void';
 
+    /**
+     * The currency or custom pricing unit to use for this ledger entry. If this is a
+     * real-world currency, it must match the customer's invoicing currency.
+     */
+    currency?: string | null;
+
     /**
      * Optional metadata that can be specified when adding ledger results via the API.
      * For example, this can be used to note an increment refers to trial credits, or
@@ -2169,6 +2252,12 @@ export namespace LedgerCreateEntryParams {
 
     entry_type: 'amendment';
 
+    /**
+     * The currency or custom pricing unit to use for this ledger entry. If this is a
+     * real-world currency, it must match the customer's invoicing currency.
+     */
+    currency?: string | null;
+
     /**
      * Optional metadata that can be specified when adding ledger results via the API.
      * For example, this can be used to note an increment refers to trial credits, or
@@ -2202,6 +2291,12 @@ export namespace LedgerCreateEntryByExternalIDParams {
 
     entry_type: 'increment';
 
+    /**
+     * The currency or custom pricing unit to use for this ledger entry. If this is a
+     * real-world currency, it must match the customer's invoicing currency.
+     */
+    currency?: string | null;
+
     /**
      * Optional metadata that can be specified when adding ledger results via the API.
      * For example, this can be used to note an increment refers to trial credits, or
@@ -2280,6 +2375,12 @@ export namespace LedgerCreateEntryByExternalIDParams {
 
     entry_type: 'decrement';
 
+    /**
+     * The currency or custom pricing unit to use for this ledger entry. If this is a
+     * real-world currency, it must match the customer's invoicing currency.
+     */
+    currency?: string | null;
+
     /**
      * Optional metadata that can be specified when adding ledger results via the API.
      * For example, this can be used to note an increment refers to trial credits, or
@@ -2323,6 +2424,12 @@ export namespace LedgerCreateEntryByExternalIDParams {
      */
     block_id?: string | null;
 
+    /**
+     * The currency or custom pricing unit to use for this ledger entry. If this is a
+     * real-world currency, it must match the customer's invoicing currency.
+     */
+    currency?: string | null;
+
     /**
      * Optional metadata that can be specified when adding ledger results via the API.
      * For example, this can be used to note an increment refers to trial credits, or
@@ -2352,6 +2459,12 @@ export namespace LedgerCreateEntryByExternalIDParams {
 
     entry_type: 'void';
 
+    /**
+     * The currency or custom pricing unit to use for this ledger entry. If this is a
+     * real-world currency, it must match the customer's invoicing currency.
+     */
+    currency?: string | null;
+
     /**
      * Optional metadata that can be specified when adding ledger results via the API.
      * For example, this can be used to note an increment refers to trial credits, or
@@ -2386,6 +2499,12 @@ export namespace LedgerCreateEntryByExternalIDParams {
 
     entry_type: 'amendment';
 
+    /**
+     * The currency or custom pricing unit to use for this ledger entry. If this is a
+     * real-world currency, it must match the customer's invoicing currency.
+     */
+    currency?: string | null;
+
     /**
      * Optional metadata that can be specified when adding ledger results via the API.
      * For example, this can be used to note an increment refers to trial credits, or
@@ -2411,6 +2530,9 @@ export interface LedgerListByExternalIDParams extends PageParams {
 
   'created_at[lte]'?: string | null;
 
+  /**
+   * The ledger currency or custom pricing unit to use.
+   */
   currency?: string | null;
 
   entry_status?: 'committed' | 'pending' | null;

package/src/resources/customers/customers.ts

@@ -243,6 +243,7 @@ export interface Customer {
    *
    * | Country              | Type         | Description                                                                                             |
    * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
+   * | Andorra              | `ad_nrt`     | Andorran NRT number                                                                                     |
    * | Australia            | `au_abn`     | Australian Business Number (AU ABN)                                                                     |
    * | Australia            | `au_arn`     | Australian Taxation Office Reference Number                                                             |
    * | Austria              | `eu_vat`     | European VAT number                                                                                     |
@@ -372,6 +373,7 @@ export namespace Customer {
    *
    * | Country              | Type         | Description                                                                                             |
    * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
+   * | Andorra              | `ad_nrt`     | Andorran NRT number                                                                                     |
    * | Australia            | `au_abn`     | Australian Business Number (AU ABN)                                                                     |
    * | Australia            | `au_arn`     | Australian Taxation Office Reference Number                                                             |
    * | Austria              | `eu_vat`     | European VAT number                                                                                     |
@@ -452,6 +454,7 @@ export namespace Customer {
    */
   export interface TaxID {
     country:
+      | 'AD'
       | 'AE'
       | 'AT'
       | 'AU'
@@ -514,6 +517,7 @@ export namespace Customer {
       | 'ZA';
 
     type:
+      | 'ad_nrt'
       | 'ae_trn'
       | 'eu_vat'
       | 'au_abn'
@@ -665,6 +669,7 @@ export interface CustomerCreateParams {
    *
    * | Country              | Type         | Description                                                                                             |
    * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
+   * | Andorra              | `ad_nrt`     | Andorran NRT number                                                                                     |
    * | Australia            | `au_abn`     | Australian Business Number (AU ABN)                                                                     |
    * | Australia            | `au_arn`     | Australian Taxation Office Reference Number                                                             |
    * | Austria              | `eu_vat`     | European VAT number                                                                                     |
@@ -808,6 +813,7 @@ export namespace CustomerCreateParams {
    *
    * | Country              | Type         | Description                                                                                             |
    * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
+   * | Andorra              | `ad_nrt`     | Andorran NRT number                                                                                     |
    * | Australia            | `au_abn`     | Australian Business Number (AU ABN)                                                                     |
    * | Australia            | `au_arn`     | Australian Taxation Office Reference Number                                                             |
    * | Austria              | `eu_vat`     | European VAT number                                                                                     |
@@ -888,6 +894,7 @@ export namespace CustomerCreateParams {
    */
   export interface TaxID {
     country:
+      | 'AD'
       | 'AE'
       | 'AT'
       | 'AU'
@@ -950,6 +957,7 @@ export namespace CustomerCreateParams {
       | 'ZA';
 
     type:
+      | 'ad_nrt'
       | 'ae_trn'
       | 'eu_vat'
       | 'au_abn'
@@ -1078,6 +1086,7 @@ export interface CustomerUpdateParams {
    *
    * | Country              | Type         | Description                                                                                             |
    * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
+   * | Andorra              | `ad_nrt`     | Andorran NRT number                                                                                     |
    * | Australia            | `au_abn`     | Australian Business Number (AU ABN)                                                                     |
    * | Australia            | `au_arn`     | Australian Taxation Office Reference Number                                                             |
    * | Austria              | `eu_vat`     | European VAT number                                                                                     |
@@ -1214,6 +1223,7 @@ export namespace CustomerUpdateParams {
    *
    * | Country              | Type         | Description                                                                                             |
    * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
+   * | Andorra              | `ad_nrt`     | Andorran NRT number                                                                                     |
    * | Australia            | `au_abn`     | Australian Business Number (AU ABN)                                                                     |
    * | Australia            | `au_arn`     | Australian Taxation Office Reference Number                                                             |
    * | Austria              | `eu_vat`     | European VAT number                                                                                     |
@@ -1294,6 +1304,7 @@ export namespace CustomerUpdateParams {
    */
   export interface TaxID {
     country:
+      | 'AD'
       | 'AE'
       | 'AT'
       | 'AU'
@@ -1356,6 +1367,7 @@ export namespace CustomerUpdateParams {
       | 'ZA';
 
     type:
+      | 'ad_nrt'
       | 'ae_trn'
       | 'eu_vat'
       | 'au_abn'
@@ -1494,6 +1506,7 @@ export interface CustomerUpdateByExternalIDParams {
    *
    * | Country              | Type         | Description                                                                                             |
    * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
+   * | Andorra              | `ad_nrt`     | Andorran NRT number                                                                                     |
    * | Australia            | `au_abn`     | Australian Business Number (AU ABN)                                                                     |
    * | Australia            | `au_arn`     | Australian Taxation Office Reference Number                                                             |
    * | Austria              | `eu_vat`     | European VAT number                                                                                     |
@@ -1630,6 +1643,7 @@ export namespace CustomerUpdateByExternalIDParams {
    *
    * | Country              | Type         | Description                                                                                             |
    * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
+   * | Andorra              | `ad_nrt`     | Andorran NRT number                                                                                     |
    * | Australia            | `au_abn`     | Australian Business Number (AU ABN)                                                                     |
    * | Australia            | `au_arn`     | Australian Taxation Office Reference Number                                                             |
    * | Austria              | `eu_vat`     | European VAT number                                                                                     |
@@ -1710,6 +1724,7 @@ export namespace CustomerUpdateByExternalIDParams {
    */
   export interface TaxID {
     country:
+      | 'AD'
       | 'AE'
       | 'AT'
       | 'AU'
@@ -1772,6 +1787,7 @@ export namespace CustomerUpdateByExternalIDParams {
       | 'ZA';
 
     type:
+      | 'ad_nrt'
       | 'ae_trn'
       | 'eu_vat'
       | 'au_abn'

package/src/resources/invoices.ts

@@ -154,6 +154,7 @@ export interface Invoice {
    *
    * | Country              | Type         | Description                                                                                             |
    * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
+   * | Andorra              | `ad_nrt`     | Andorran NRT number                                                                                     |
    * | Australia            | `au_abn`     | Australian Business Number (AU ABN)                                                                     |
    * | Australia            | `au_arn`     | Australian Taxation Office Reference Number                                                             |
    * | Austria              | `eu_vat`     | European VAT number                                                                                     |
@@ -508,6 +509,7 @@ export namespace Invoice {
    *
    * | Country              | Type         | Description                                                                                             |
    * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
+   * | Andorra              | `ad_nrt`     | Andorran NRT number                                                                                     |
    * | Australia            | `au_abn`     | Australian Business Number (AU ABN)                                                                     |
    * | Australia            | `au_arn`     | Australian Taxation Office Reference Number                                                             |
    * | Austria              | `eu_vat`     | European VAT number                                                                                     |
@@ -588,6 +590,7 @@ export namespace Invoice {
    */
   export interface CustomerTaxID {
     country:
+      | 'AD'
       | 'AE'
       | 'AT'
       | 'AU'
@@ -650,6 +653,7 @@ export namespace Invoice {
       | 'ZA';
 
     type:
+      | 'ad_nrt'
       | 'ae_trn'
       | 'eu_vat'
       | 'au_abn'
@@ -1230,6 +1234,7 @@ export interface InvoiceFetchUpcomingResponse {
    *
    * | Country              | Type         | Description                                                                                             |
    * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
+   * | Andorra              | `ad_nrt`     | Andorran NRT number                                                                                     |
    * | Australia            | `au_abn`     | Australian Business Number (AU ABN)                                                                     |
    * | Australia            | `au_arn`     | Australian Taxation Office Reference Number                                                             |
    * | Austria              | `eu_vat`     | European VAT number                                                                                     |
@@ -1584,6 +1589,7 @@ export namespace InvoiceFetchUpcomingResponse {
    *
    * | Country              | Type         | Description                                                                                             |
    * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
+   * | Andorra              | `ad_nrt`     | Andorran NRT number                                                                                     |
    * | Australia            | `au_abn`     | Australian Business Number (AU ABN)                                                                     |
    * | Australia            | `au_arn`     | Australian Taxation Office Reference Number                                                             |
    * | Austria              | `eu_vat`     | European VAT number                                                                                     |
@@ -1664,6 +1670,7 @@ export namespace InvoiceFetchUpcomingResponse {
    */
   export interface CustomerTaxID {
     country:
+      | 'AD'
       | 'AE'
       | 'AT'
       | 'AU'
@@ -1726,6 +1733,7 @@ export namespace InvoiceFetchUpcomingResponse {
       | 'ZA';
 
     type:
+      | 'ad_nrt'
       | 'ae_trn'
       | 'eu_vat'
       | 'au_abn'

package/src/resources/plans/plans.ts

@@ -289,8 +289,8 @@ export namespace Plan {
 
 export interface PlanCreateParams {
   /**
-   * An ISO 4217 currency string or custom pricing unit (`credits`) for this plan's
-   * prices.
+   * An ISO 4217 currency string for invoices generated by subscriptions on this
+   * plan.
    */
   currency: string;
 

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.33.1'; // x-release-please-version
+export const VERSION = '1.34.1'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.33.1";
+export declare const VERSION = "1.34.1";
 //# 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 = '1.33.1'; // x-release-please-version
+exports.VERSION = '1.34.1'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '1.33.1'; // x-release-please-version
+export const VERSION = '1.34.1'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map