Skip to main content

Interface: CreateOnetimeRequest

Extends​

Properties​

add_to_next_charge?​

optional add_to_next_charge?: boolean

Instructs to add the Onetime to the next charge scheduled under this Address.

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)

Inherited from​

Onetime.address_id

external_product_id?​

optional external_product_id?: ExternalId

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

Inherited from​

Onetime.external_product_id

external_variant_id​

external_variant_id: ExternalId

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

Inherited from​

Onetime.external_variant_id

gift_id?​

optional gift_id?: number

When creating a onetime using a gift, pass the credit_account_id that is associated with that gift. This will create the onetime using the credit account associated with the gift.

next_charge_scheduled_at?​

optional next_charge_scheduled_at?: string

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

Inherited from​

Onetime.next_charge_scheduled_at

product_title?​

optional product_title?: string

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

Inherited from​

Onetime.product_title

properties?​

optional properties?: Property[]

An array containing key value pairs for any supplementary data.

Inherited from​

Onetime.properties

quantity​

quantity: number

The number of items in the Onetime purchase.

Inherited from​

Onetime.quantity

sku?​

optional sku?: string | null

A unique identifier of the item in the fulfillment.

Inherited from​

Onetime.sku