ProvisionOrder
Billing terms you can set on an order.
- currencyType: stringrequired
ISO 4217 code the order is priced and billed in.
- externalType: string
Id requiredYour ID for the order, such as the CRM deal ID.
- Properties: 9linesType: 1…required
- startType: string
Date requiredThe day the order starts, as a date (YYYY-MM-DD) or ISO 8601 date-time.
- autoType: boolean | null
Post Invoices Post the order's invoices as soon as the billing run makes them. Null or false, they wait as drafts for you to post.
- autoType: boolean | null
Send Billing Emails Email each invoice when it is posted, and reminders on its due date and 3, 7 and 14 days after while it is unpaid (unless Stripe is collecting it). A credit invoice (a negative total) is emailed as a credit, and an invoice with a zero total as one with nothing to pay; an invoice that owes nothing gets no reminders. They go to the billing contacts, else the customer's billing contacts, else the customer's email. Null or false, no emails.
- autoType: boolean | null
Send Payment Emails Email a receipt when an invoice is paid in full, stating the amount of the payment that settled it, unless nothing was paid (its total is zero or less, or Stripe settled it from the customer's Stripe balance). Null or false, no receipt.
- billingType: integer | null
Anchor min:1max:31The day of the month the order's billing periods start, fixed once the order isn't a draft. Defaults to the start date's day. In shorter months the period starts on the month's last day. When the start date falls on another day, the first period runs from the start date to the first anchor day and is prorated.
- billingType: array of string
Contact External Ids Your IDs for the contacts who receive the order's invoices, such as the request's
contactor contacts made with Create a contact. Each must be a contact of the customer or of the billing customer (400 otherwise). - billingType: string
Customer External Id Your ID for another customer who pays for the order. It must exist.
- billingType: integer | null
Frequency Custom Months min:1max:60Months in each billing period when
billingFrequencyOverrideiscustom, a whole number from 1 to 60 (400 otherwise). Default 1. Fixed once the order isn't a draft. - billingType: string | null
Frequency Override Bill the order's recurring and seat-based charges at this frequency (
monthly,quarterly,semiAnnually,annual, orcustomfor everybillingFrequencyCustomMonthsmonths) instead of each charge's own. Usage and one-time charges keep theirs. Fixed once the order isn't a draft. - endType: string
Date The day the order ends, as a date or date-time.
- nameType: string
The order's name. Default, the existing order's name, else its products' names.
- paymentType: string | nullenum
Terms When the order's invoices fall due, counted from when each is posted. Null for 14 days.
valuesDueOnReceiptNet15Net30Net45Net60Net90null - purchaseType: string | null
Order Reference Your customer's purchase order reference, shown on the order's invoices.
- statusType: "draft" or "active"enum
activeactivates the order (see Activate an order). - subscriptionType: object | null
Terms Properties: 1Your subscription terms for the order (term length, renewal), kept with the order and returned as sent.