Skip to main content

Interface: CreateMetafieldRequest

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.

description?​

optional description: string

Description of the metafield.

Inherited from​

SubType.description

key​

key: string

The name of the metafield.

Inherited from​

SubType.key

namespace​

namespace: string

A category or container that differentiates your metadata from other metafields.

Inherited from​

SubType.namespace

owner_id​

owner_id: number

Unique numeric identifier of the owner_resource.

Inherited from​

SubType.owner_id

owner_resource​

owner_resource: MetafieldOwnerResource

Objects which support Metafields

Inherited from​

SubType.owner_resource

value​

value: string

The content of the metafield.

Inherited from​

SubType.value

value_type​

value_type: "string" | "integer" | "json_string"

The type of the value parameter.

Inherited from​

SubType.value_type