Order

Whether the order's invoices are posted as soon as the billing run makes them. Null or false, they wait as drafts for you to post.

Whether invoices are emailed to the billing contacts when posted, with payment reminders once they fall due. Null or false, no emails.

Whether a receipt is emailed when an invoice is paid in full, stating the amount of the payment that settled it. None is sent when nothing was paid: an invoice with a total of zero or less, or one Stripe settled from the customer's Stripe balance. Null or false, no receipt.

Total of the order's posted invoices before tax; drafts and voided invoices aren't counted. Decimal amount in major units.

Tax on the order's posted invoices; drafts and voided invoices aren't counted. Decimal amount in major units.

How far the billing run has got with the order, at midnight UTC: the latest cycle boundary (a cycle's start, or the order's end) it has billed, making an invoice when anything was due. Charges due after it go on the order's next invoice; for an ended order, anything owed after its final invoice goes on a true-up invoice, for up to 90 days after its end, or after its end date last moved. Null until the first.

The day of the month the order's billing cycles start, as set in its terms, else its start date's day.

The contacts (con_…) who receive this order's invoices, each a contact of the customer or of the billing customer. Contacts are managed with the Contacts operations, such as Create a contact.

Another customer who pays for this order, when it isn't the customer it is for. The order's invoices are made out to them.

Months in each billing period when billingFrequencyOverride is custom, as set in the order's terms; null when not set, in which case a custom override bills every month.

Whether billingFrequencyOverride is set.

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

draft until the order is activated, then active, which it stays after the order ends.

ISO 4217 code the order is priced and billed in.

The customer the order is for.

The day the order ends, at midnight UTC, or null when it runs until ended. An order billed through a Stripe subscription (bought on Stripe Checkout) has the subscription cancelled in Stripe once this day comes, with the unused part of its fee credited and usage so far billed. For 90 days after an order ends, or after its end date last moved (by a backdated activation, a new endDate sent with Update an order or an updateOrderTerm amendment, not by other changes such as a new name; so an order a backdated activation ends on an earlier day is credited however far back that day is), anything still owed for it once its final invoice is made (usage sent late, a credit correction) is billed on an invoice of its own, dated when the billing run makes it.

Estimated tax on what is still to be billed. Decimal amount in major units.

The order's Spondo Billing ID.

Your own key-value data, kept with the record and returned as sent.

The order's name. Defaults to its products' names joined with " + ".

The order's sequential number in your account.

The order's recurring amount per month: its recurring and per-seat fees times their quantities, with longer billing frequencies spread over their months. Usage and one-time charges aren't included. Decimal amount in major units.

When the order's invoices fall due, counted from when each is posted; null for 14 days.

What the order's next invoice holds so far: the charges due by its next billing date (its next cycle start, or its end) that haven't been invoiced yet, with usage to date, after discounts and before tax. When the current cycle hasn't been invoiced yet (an order just activated), its invoice comes first and isn't counted here. 0 for draft, paused and ended orders (an ended order's next invoice, if any, is a true-up). Decimal amount in major units.

Your customer's purchase order reference, shown on the order's invoices.

Whether the order's invoices show your bank details, or null for your account's default.

Whether the order's invoices show a payment link, or null for your account's default.

The day the order starts, at midnight UTC.

Where the order is in its life. draft: not yet activated. active: activated and before its end date. paused: billing paused. ended: cancelled (for example replaced by a newer order on the same product) or on or after its end date, the first day it doesn't run.

Your subscription terms for the order (term length, renewal), kept with the order and returned as sent.

The order's total recurring amount per month, as orderAmount. Decimal amount in major units.

Total of the order's posted invoices including tax; drafts and voided invoices aren't counted. Decimal amount in major units.

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Starts at 1 and goes up by one with each amendment. Previews and amendments must send the current version.

Bill the order's recurring and seat-based charges at this frequency (monthly, quarterly, semiAnnually, annual, or custom for every billingFrequencyCustomMonths months) instead of each charge's own. Present only when set.