Skip to main content

Interface: Onetime

Properties

address_id

address_id: number

Unique numeric identifier for the address the Onetime Purchase is associated with (cannot be used with next_charge_scheduled_at)


created_at

created_at: string

The time the Onetime item was first created.


customer_id

customer_id: number

Unique numeric identifier for the customer the Onetime purchase is tied to.


external_product_id

external_product_id: ExternalId

An object containing the product id as it appears in external platforms.


external_variant_id

external_variant_id: ExternalId

An object containing the variant id as it appears in external platforms.


id

id: number

Unique numeric identifier for the Onetime purchase.


is_cancelled

is_cancelled: boolean

Flag indicating if the the onetime is cancelled.


next_charge_scheduled_at

next_charge_scheduled_at: string

Date of the Onetime purchase execution. Cannot be used with add_to_next_charge


presentment_currency

presentment_currency: string

Presentment currency


price

price: string

The price of the item before discounts, taxes, or shipping have been applied.


product_title

product_title: string

The name of the product in a shop’s catalog.


properties

properties: Property[]

An array containing key value pairs for any supplementary data.


quantity

quantity: number

The number of items in the Onetime purchase.


sku

sku: string

A unique identifier of the item in the fulfillment.


sku_override

sku_override: boolean

Flag that is automatically updated to true when SKU is passed on POST or PUT.


updated_at

updated_at: string

The time the Onetime purchase was last updated.


variant_title

variant_title: string

The name of the variant in a shop’s catalog.