orb-billing 1.0.1

package/dist/sdk/models/shared/index.js

@@ -0,0 +1,144 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./action"), exports);
+__exportStar(require("./amendedevent"), exports);
+__exportStar(require("./amendedusage"), exports);
+__exportStar(require("./amendeventresult"), exports);
+__exportStar(require("./autocollection"), exports);
+__exportStar(require("./availability"), exports);
+__exportStar(require("./backfill"), exports);
+__exportStar(require("./backfills"), exports);
+__exportStar(require("./backfillstatus"), exports);
+__exportStar(require("./billablemetric"), exports);
+__exportStar(require("./billablemetricminified"), exports);
+__exportStar(require("./bpsconfig"), exports);
+__exportStar(require("./bpspriceoverride"), exports);
+__exportStar(require("./bpstier"), exports);
+__exportStar(require("./bulkbpsconfig"), exports);
+__exportStar(require("./bulkbpspriceoverride"), exports);
+__exportStar(require("./bulkbpstier"), exports);
+__exportStar(require("./bulkconfig"), exports);
+__exportStar(require("./bulkpriceoverride"), exports);
+__exportStar(require("./bulktier"), exports);
+__exportStar(require("./cadence"), exports);
+__exportStar(require("./canceloption"), exports);
+__exportStar(require("./changeoption"), exports);
+__exportStar(require("./changeoption1"), exports);
+__exportStar(require("./coupon"), exports);
+__exportStar(require("./coupons"), exports);
+__exportStar(require("./credit"), exports);
+__exportStar(require("./creditblock"), exports);
+__exportStar(require("./creditledgerentries"), exports);
+__exportStar(require("./creditledgerentry"), exports);
+__exportStar(require("./creditnote"), exports);
+__exportStar(require("./creditnotelineitem"), exports);
+__exportStar(require("./creditnotes"), exports);
+__exportStar(require("./creditnotesummary"), exports);
+__exportStar(require("./creditnotetype"), exports);
+__exportStar(require("./credits"), exports);
+__exportStar(require("./customer"), exports);
+__exportStar(require("./customerbalancetransaction"), exports);
+__exportStar(require("./customercost"), exports);
+__exportStar(require("./customercosts"), exports);
+__exportStar(require("./customerminified"), exports);
+__exportStar(require("./customers"), exports);
+__exportStar(require("./debug"), exports);
+__exportStar(require("./deprecatedeventresult"), exports);
+__exportStar(require("./discount"), exports);
+__exportStar(require("./discounttype"), exports);
+__exportStar(require("./durationunit"), exports);
+__exportStar(require("./entrystatus"), exports);
+__exportStar(require("./entrytype"), exports);
+__exportStar(require("./event"), exports);
+__exportStar(require("./eventsearchcriteria"), exports);
+__exportStar(require("./eventsearchresults"), exports);
+__exportStar(require("./externalmarketplace"), exports);
+__exportStar(require("./fixedfeequantitychange"), exports);
+__exportStar(require("./fixedfeequantityschedule"), exports);
+__exportStar(require("./granularity"), exports);
+__exportStar(require("./grouping"), exports);
+__exportStar(require("./ingestionresponse"), exports);
+__exportStar(require("./invoice"), exports);
+__exportStar(require("./invoicelineitem"), exports);
+__exportStar(require("./invoices"), exports);
+__exportStar(require("./invoicesettings"), exports);
+__exportStar(require("./invoicestatus"), exports);
+__exportStar(require("./lineitem"), exports);
+__exportStar(require("./matrixconfig"), exports);
+__exportStar(require("./matrixconfig1"), exports);
+__exportStar(require("./matrixvalue"), exports);
+__exportStar(require("./modeltype"), exports);
+__exportStar(require("./newbackfill"), exports);
+__exportStar(require("./newcoupon"), exports);
+__exportStar(require("./newcreditledgerentry"), exports);
+__exportStar(require("./newcustomer"), exports);
+__exportStar(require("./newinvoicelineitem"), exports);
+__exportStar(require("./newsubscription"), exports);
+__exportStar(require("./newtransaction"), exports);
+__exportStar(require("./packageconfig"), exports);
+__exportStar(require("./packagepriceoverride"), exports);
+__exportStar(require("./paginationmetadata"), exports);
+__exportStar(require("./perpricecost"), exports);
+__exportStar(require("./phaseoverride"), exports);
+__exportStar(require("./plan"), exports);
+__exportStar(require("./planminified"), exports);
+__exportStar(require("./planphase"), exports);
+__exportStar(require("./plans"), exports);
+__exportStar(require("./price"), exports);
+__exportStar(require("./pricegroup"), exports);
+__exportStar(require("./product"), exports);
+__exportStar(require("./reason"), exports);
+__exportStar(require("./requestvalidationerror"), exports);
+__exportStar(require("./security"), exports);
+__exportStar(require("./sublineitem"), exports);
+__exportStar(require("./sublineitem1"), exports);
+__exportStar(require("./sublineitem2"), exports);
+__exportStar(require("./subscription"), exports);
+__exportStar(require("./subscriptioncancellation"), exports);
+__exportStar(require("./subscriptioncost"), exports);
+__exportStar(require("./subscriptioncosts"), exports);
+__exportStar(require("./subscriptionminified"), exports);
+__exportStar(require("./subscriptionplanchange"), exports);
+__exportStar(require("./subscriptions"), exports);
+__exportStar(require("./subscriptionschedule"), exports);
+__exportStar(require("./subscriptionscheduleitem"), exports);
+__exportStar(require("./subscriptionstatus"), exports);
+__exportStar(require("./subscriptionusage"), exports);
+__exportStar(require("./taxamount"), exports);
+__exportStar(require("./tier"), exports);
+__exportStar(require("./tier7"), exports);
+__exportStar(require("./tierconfig"), exports);
+__exportStar(require("./tieredbpsconfig"), exports);
+__exportStar(require("./tieredbpsconfig1"), exports);
+__exportStar(require("./tieredbpspriceoverride"), exports);
+__exportStar(require("./tieredconfig"), exports);
+__exportStar(require("./tieredpriceoverride"), exports);
+__exportStar(require("./transactions"), exports);
+__exportStar(require("./transactiontype"), exports);
+__exportStar(require("./trialconfig"), exports);
+__exportStar(require("./type"), exports);
+__exportStar(require("./unitconfig"), exports);
+__exportStar(require("./unitpriceoverride"), exports);
+__exportStar(require("./upcominginvoice"), exports);
+__exportStar(require("./updateevent"), exports);
+__exportStar(require("./usage"), exports);
+__exportStar(require("./usageitem"), exports);
+__exportStar(require("./validationerrors"), exports);
+__exportStar(require("./viewmode"), exports);

package/dist/sdk/models/shared/ingestionresponse.d.ts

@@ -0,0 +1,13 @@
+import { SpeakeasyBase } from "../../../internal/utils";
+import { Debug } from "./debug";
+import { ValidationErrors } from "./validationerrors";
+/**
+ * OK
+ */
+export declare class IngestionResponse extends SpeakeasyBase {
+    debug?: Debug;
+    /**
+     * Contains all failing validation events. In the case of a 200, this array will always be empty. This field will always be present.
+     */
+    validationFailed: ValidationErrors[];
+}

package/dist/sdk/models/shared/ingestionresponse.js

@@ -0,0 +1,57 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IngestionResponse = void 0;
+var utils_1 = require("../../../internal/utils");
+var debug_1 = require("./debug");
+var validationerrors_1 = require("./validationerrors");
+var class_transformer_1 = require("class-transformer");
+/**
+ * OK
+ */
+var IngestionResponse = /** @class */ (function (_super) {
+    __extends(IngestionResponse, _super);
+    function IngestionResponse() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "debug" }),
+        (0, class_transformer_1.Type)(function () { return debug_1.Debug; }),
+        __metadata("design:type", debug_1.Debug)
+    ], IngestionResponse.prototype, "debug", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)({ elemType: validationerrors_1.ValidationErrors }),
+        (0, class_transformer_1.Expose)({ name: "validation_failed" }),
+        (0, class_transformer_1.Type)(function () { return validationerrors_1.ValidationErrors; }),
+        __metadata("design:type", Array)
+    ], IngestionResponse.prototype, "validationFailed", void 0);
+    return IngestionResponse;
+}(utils_1.SpeakeasyBase));
+exports.IngestionResponse = IngestionResponse;

package/dist/sdk/models/shared/invoice.d.ts

@@ -0,0 +1,274 @@
+import { SpeakeasyBase } from "../../../internal/utils";
+import { AutoCollection } from "./autocollection";
+import { CreditNoteSummary } from "./creditnotesummary";
+import { CustomerMinified } from "./customerminified";
+import { DiscountType } from "./discounttype";
+import { InvoiceLineItem } from "./invoicelineitem";
+import { InvoiceStatus } from "./invoicestatus";
+import { SubscriptionMinified } from "./subscriptionminified";
+import { Transactions } from "./transactions";
+/**
+ * Tax IDs are commonly required to be displayed on customer invoices, which are added to the headers of invoices.
+ *
+ * @remarks
+ *
+ *
+ * ### Supported Tax ID Countries and Types
+ *
+ *
+ * | Country        | Type         | Description                                 |
+ * |----------------|--------------|---------------------------------------------|
+ * | Australia      | `au_abn`     | Australian Business Number (AU ABN)	        |
+ * | Australia      | `au_arn`     | Australian Taxation Office Reference Number |
+ * | Austria        | `eu_vat`     | European VAT number                         |
+ * | Belgium        | `eu_vat`     | European VAT number                         |
+ * | Brazil         | `br_cnpj`    | Brazilian CNPJ number                       |
+ * | Brazil         | `br_cpf`     | Brazilian CPF number	                       |
+ * | Bulgaria       | `bg_uic`     | Bulgaria Unified Identification Code        |
+ * | Bulgaria       | `eu_vat`     | European VAT number                         |
+ * | Canada         | `ca_bn`      | Canadian BN                                 |
+ * | Canada         | `ca_gst_hst` | Canadian GST/HST number                     |
+ * | Canada         | `ca_pst_bc`  | Canadian PST number (British Columbia)      |
+ * | Canada         | `ca_pst_mb`  | Canadian PST number (Manitoba)              |
+ * | Canada         | `ca_pst_sk`  | Canadian PST number (Saskatchewan)          |
+ * | Canada         | `ca_qst`     | Canadian QST number (Québec)                |
+ * | Chile          | `cl_tin`     | Chilean TIN                                 |
+ * | Croatia        | `eu_vat`     | European VAT number                         |
+ * | Cyprus         | `eu_vat`     | European VAT number                         |
+ * | Czech Republic | `eu_vat`     | European VAT number                         |
+ * | Denmark        | `eu_vat`     | European VAT number                         |
+ * | Egypt          | `eg_tin`     | Egyptian Tax Identification Number	         |
+ * | Estonia   | `eu_vat`     | European VAT number   |
+ * | EU        | `eu_oss_vat` | European One Stop Shop VAT number for non-Union scheme                                                   |
+ * | Finland   | `eu_vat`     | European VAT number                                                                                      |
+ * | France    | `eu_vat`     | European VAT number                                                                                      |
+ * | Georgia   | `ge_vat`     | Georgian VAT                                                                                             |
+ * | Germany   | `eu_vat`     | European VAT number                                                                                      |
+ * | Greece    | `eu_vat`     | European VAT number                                                                                      |
+ * | Hong Kong | `hk_br`      | Hong Kong BR number                                                                                      |
+ * | Hungary   | `eu_vat`     | European VAT number                                                                                      |
+ * | Hungary   | `hu_tin`     | Hungary tax number (adószám)	                                                                            |
+ * | Iceland   | `is_vat`     | Icelandic VAT                                                                                            |
+ * | India     | `in_gst`     | Indian GST number                                                                                        |
+ * | Indonesia | `id_npwp`    | Indonesian NPWP number                                                                                   |
+ * | Ireland   | `eu_vat`     | European VAT number                                                                                      |
+ * | Israel    | `il_vat`     | Israel VAT                                                                                               |
+ * | Italy     | `eu_vat`     | European VAT number                                                                                      |
+ * | Japan     | `jp_cn`      | Japanese Corporate Number (*Hōjin Bangō*)                                                                |
+ * | Japan     | `jp_rn`      | Japanese Registered Foreign Businesses' Registration Number (*Tōroku Kokugai Jigyōsha no Tōroku Bangō*)	 |
+ * | Japan     | `jp_trn`     | Japanese Tax Registration Number (*Tōroku Bangō*)	                                                       |
+ * | Kenya     | `ke_pin`     | Kenya Revenue Authority Personal Identification Number                                                   |
+ * | Latvia    | `eu_vat`     | European VAT number                                                                                  |
+ * | Liechtenstein | `li_uid`  | Liechtensteinian UID number           |
+ * | Lithuania     | `eu_vat`  | European VAT number	                  |
+ * | Luxembourg    | `eu_vat`  | European VAT number	                  |
+ * | Malaysia      | `my_frp`  | Malaysian FRP number                  |
+ * | Malaysia      | `my_itn`  | Malaysian ITN                         |
+ * | Malaysia      | `my_sst`  | Malaysian SST number                  |
+ * | Malta         | `eu_vat ` | European VAT number                   |
+ * | Mexico        | `mx_rfc`  | Mexican RFC number                    |
+ * | Netherlands   | `eu_vat`  | European VAT number	                  |
+ * | New Zealand   | `nz_gst`  | New Zealand GST number	               |
+ * | Norway        | `no_vat`  | Norwegian VAT number                  |
+ * | Philippines   | `ph_tin	` | Philippines Tax Identification Number |
+ * | Poland        | `eu_vat`  | European VAT number                   |
+ * | Portugal      | `eu_vat`  | European VAT number                   |
+ * | Romania       | `eu_vat`  | European VAT number                   |
+ * | Russia        | `ru_inn`  | Russian INN                           |
+ * | Russia        | `ru_kpp`  | Russian KPP                           |
+ * | Saudi Arabia  | `sg_gst`  | Singaporean GST                       |
+ * | Singapore     | `sg_uen`  | Singaporean UEN	                      |
+ * | Slovakia      | `eu_vat`  | European VAT number                   |
+ * | Slovenia      | `eu_vat`  | European VAT number                   |
+ * | Slovenia             | `si_tin` | Slovenia tax number (davčna številka)	             |
+ * | South Africa	        | `za_vat` | South African VAT number                           |
+ * | South Korea          | `kr_brn` | Korean BRN                                         |
+ * | Spain                | `es_cif` | Spanish NIF number (previously Spanish CIF number) |
+ * | Spain                | `eu_vat` | European VAT number	                               |
+ * | Sweden               | `eu_vat` | European VAT number                                |
+ * | Switzerland          | `ch_vat` | Switzerland VAT number	                            |
+ * | Taiwan               | `tw_vat` | Taiwanese VAT	                                     |
+ * | Thailand             | `th_vat` | Thai VAT                                           |
+ * | Turkey               | `tr_tin` | Turkish Tax Identification Number                  |
+ * | Ukraine              | `ua_vat` | Ukrainian VAT                                      |
+ * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN	                          |
+ * | United Kingdom       | `eu_vat` | Northern Ireland VAT number                        |
+ * | United Kingdom       | `gb_vat` | United Kingdom VAT number                          |
+ * | United States        | `us_ein` | United States EIN                                  |
+ */
+export declare class InvoiceCustomerTaxID extends SpeakeasyBase {
+    /**
+     * Two-letter ISO code representing the country of the tax ID
+     */
+    country: string;
+    /**
+     * One of `ae_trn`, `au_abn`, `au_arn`, `bg_uic`, `br_cn`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ph_tin`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, or `za_va`
+     */
+    type: string;
+    /**
+     * The value of the ID
+     */
+    value: string;
+}
+export declare class InvoiceDiscount extends SpeakeasyBase {
+    /**
+     * Only available if discount_type is `amount`.
+     */
+    amountDiscount?: string;
+    /**
+     * List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
+     */
+    appliesToPriceIds?: string[];
+    discountType: DiscountType;
+    /**
+     * Only available if discount_type is `percentage`.This is a number between 0 and 1.
+     */
+    percentageDiscount?: number;
+    /**
+     * Only available if discount_type is `trial`
+     */
+    trialAmountDiscount?: string;
+    /**
+     * Only available if discount_type is `usage`. Number of usage units that this discount is for
+     */
+    usageDiscount?: number;
+}
+export declare class InvoiceMaximumAmount extends SpeakeasyBase {
+    /**
+     * List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
+     */
+    appliesToPriceIds: string[];
+    /**
+     * Maximum amount applied
+     */
+    maximumAmount: string;
+}
+export declare class InvoiceMinimumAmount extends SpeakeasyBase {
+    /**
+     * List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
+     */
+    appliesToPriceIds: string[];
+    /**
+     * Minimum amount applied
+     */
+    minimumAmount: string;
+}
+/**
+ * An [`Invoice`](../guides/concepts#invoice) is a fundamental billing entity, representing the request for payment for a single subscription. This includes a set of line items, which correspond to prices in the subscription's plan and can represent fixed recurring fees or usage-based fees. They are generated at the end of a billing period, or as the result of an action, such as a cancellation.
+ */
+export declare class Invoice extends SpeakeasyBase {
+    /**
+     * This is the final amount required to be charged to the customer and reflects the application of the customer balance to the `total` of the invoice.
+     */
+    amountDue: string;
+    /**
+     * Information about payment auto-collection for this invoice.
+     */
+    autoCollection?: AutoCollection;
+    /**
+     * The creation time of the resource in Orb.
+     */
+    createdAt: Date;
+    /**
+     * A list of credit notes associated with the invoice
+     */
+    creditNotes?: CreditNoteSummary[];
+    /**
+     * An ISO 4217 currency string or `credits`
+     */
+    currency: string;
+    /**
+     * The customer receiving this invoice.
+     */
+    customer: CustomerMinified;
+    customerBalanceTransactions: Transactions;
+    customerTaxId?: InvoiceCustomerTaxID;
+    discount: InvoiceDiscount;
+    /**
+     * When the invoice payment is due.
+     */
+    dueDate: Date;
+    /**
+     * If the invoice has a status of `draft`, this will be the time that the invoice willl be eligible to be issued, otherwise it will be `null`. If `auto-issue` is true, the invoice will automatically begin issuing at this time.
+     */
+    eligibleForIssueAt?: Date;
+    /**
+     * A URL for the invoice portal.
+     */
+    hostedInvoiceUrl?: string;
+    id: string;
+    /**
+     * Issue date of the invoice
+     */
+    invoiceDate: Date;
+    /**
+     * Automatically generated invoice number to help track and reconcile invoices. Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per account or customer.
+     */
+    invoiceNumber: string;
+    /**
+     * The link to download the PDF representation of the `Invoice`.
+     */
+    invoicePdf: string;
+    /**
+     * If the invoice failed to issue, this will be the last time it failed to issue (even if it is now in a different state.)
+     */
+    issueFailedAt?: Date;
+    /**
+     * If the invoice has been issued, this will be the time it transitioned to `issued` (even if it is now in a different state.)
+     */
+    issuedAt?: Date;
+    /**
+     * The breakdown of prices in this invoice.
+     */
+    lineItems: InvoiceLineItem[];
+    maximum?: InvoiceMaximumAmount;
+    /**
+     * Free-form text which is available on the invoice PDF and the Orb invoice portal.
+     */
+    memo?: string;
+    minimum: InvoiceMinimumAmount;
+    /**
+     * If the invoice has a status of `paid`, this gives a timestamp when the invoice was paid.
+     */
+    paidAt?: Date;
+    /**
+     * If payment was attempted on this invoice but failed, this will be the time of the most recent attempt.
+     */
+    paymentFailedAt?: Date;
+    /**
+     * If payment was attempted on this invoice, this will be the start time of the most recent attempt. This field is especially useful for delayed-notification payment mechanisms (like bank transfers), where payment can take 3 days or more.
+     */
+    paymentStartedAt?: Date;
+    /**
+     * If the invoice is in draft, this timestamp will reflect when the invoice is scheduled to be issued.
+     */
+    scheduledIssueAt?: Date;
+    /**
+     * The status of this invoice as known to Orb. Invoices start in `"draft"` state for a given billing period, and are automatically transitioned to `"issued"` when that billing period ends. Invoices will be marked `"paid"` upon confirmation of successful automatic payment collection by Orb. Invoices may be manually voided; those will be in the terminal `"void"` state. Invoices synced to an external billing provider (such as Bill.com, QuickBooks, or Stripe Invoicing) will be marked as `"synced"`.
+     */
+    status: InvoiceStatus;
+    /**
+     * The associated subscription for this invoice.
+     */
+    subscription: SubscriptionMinified;
+    /**
+     * The total before any discounts and minimums are applied.
+     */
+    subtotal: string;
+    /**
+     * If the invoice failed to sync, this will be the last time an external invoicing provider sync was attempted. This field will always be `null` for invoices using Orb Invoicing.
+     */
+    syncFailedAt?: Date;
+    /**
+     * The total after any minimums, discounts, and taxes have been applied.
+     */
+    total: string;
+    /**
+     * If the invoice has a status of `void`, this gives a timestamp when the invoice was voided.
+     */
+    voidedAt?: Date;
+    /**
+     * This is true if the invoice will be automaticaly issued in the future, and false otherwise.
+     */
+    willAutoIssue: boolean;
+}