CreateOnetimeRequest
Extends
Properties
add_to_next_charge?
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
SubType.address_id
external_product_id?
external_product_id?:
ExternalId
An object containing the product id as it appears in external platforms.
Inherited from
SubType.external_product_id
external_variant_id
external_variant_id:
ExternalId
An object containing the variant id as it appears in external platforms.
Inherited from
SubType.external_variant_id
gift_id?
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?
next_charge_scheduled_at?:
string
Date of the Onetime purchase execution. Cannot be used with add_to_next_charge
Inherited from
SubType.next_charge_scheduled_at
price?
price?:
string
The price of the item before discounts, taxes, or shipping have been applied.
Inherited from
SubType.price
product_title
product_title:
string
The name of the product in a shop’s catalog.
Inherited from
SubType.product_title
properties?
properties?:
Property[]
An array containing key value pairs for any supplementary data.
Inherited from
SubType.properties
quantity
quantity:
number
The number of items in the Onetime purchase.
Inherited from
SubType.quantity
sku?
sku?:
string
A unique identifier of the item in the fulfillment.
Inherited from
SubType.sku
Generated using typedoc-plugin-markdown and TypeDoc