Upsell
Creates a new line item as an upsell. An attempt to pay the upsell will be made using the payment method on the checkout.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Whether or not the endpoint should return a preview of the result. If true, no modifications to the resource will be saved.
Body
Response
Success
The UUID of the specific object.
A string describing the object type returned.
The amount to use for this line item when the associated price is ad_hoc=true.
The quantity of products being purchased.
A custom note for this line item. Useful for adding context or special instructions related to the product or purchase.
Expandable – The associated bump ID.
Expandable – The associated checkout ID.
The total amount of checkout fees applied to this line item.
Total discount amount applied to this line item.
Expandable – Property not returned unless expanded.
The total amount of fees applied to this line item.
The full amount to be charged across all periods.
The quantity of products that have been fulfilled.
Total weight of all items (quantity * unit_g_weight) in grams.
Whether or not this line item is locked. If locked, it cannot be edited or deleted. Line items are locked when an invoice is opened.
Expandable – The associated price ID.
Total weight of the product in grams.
The status indicating if this line item can be purchased (finalized with) or not and why. Possible values are price_gone, price_old_version, variant_mising, variant_gone, variant_old_version, out_of_stock, exceeds_purchase_limit, or purchasable.
The amount in cents that should be shown as the original amount before any price reductions, also known as the pre-sale price.
Whether or not stock is being held for this line item. (This only applies to the quantity that has not been fulfilled.)
Total before any discounts or taxes are applied.
Expandable – The associated swap ID.
Total tax amount.
The tax rate for this line item.
Total after discounts and taxes are applied.
The total amount in cents that was saved on this line item taking into account all negative fees, discounts, and all price scratch_amount values.
Set to true if this line item is for a price that has a trial.
The total amount in cents that is removed from this line item due to a trial period.
Expandable – The associated upsell ID.
Expandable – The associated variant ID.
An array of the associated variant's options.
An array of the associated product's variant option names.
Time at which the object was created. Measured in seconds since the Unix epoch.
Time at which the object was last updated. Measured in seconds since the Unix epoch.