The shipping method tier object

A comprehensive list of the shipping method tier resource's attributes and relationships

A shipping method tier object is returned as part of the response body of each successful list or retrieve API call to the /api/shipping_method_tiers endpoint.

Fields

FieldTypeDescription

type

string

shipping_method_tiers

id

string

The shipping method tier unique identifier

links.self

string

The shipping method tier endpoint URL

attributes.name

string

The shipping method tier's name.

attributes.up_to

float

The tier upper limit. When 'null' it means infinity (useful to have an always matching tier).

attributes.price_amount_cents

integer

The price of this shipping method tier, in cents.

attributes.price_amount_float

float

The price of this shipping method tier, float.

attributes.formatted_price_amount

string

The price of this shipping method tier, formatted.

attributes.created_at

datetime

Time at which the resource was created.

attributes.updated_at

datetime

Time at which the resource was last updated.

attributes.reference

string

A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.

attributes.reference_origin

string

Any identifier of the third party system that defines the reference code.

attributes.metadata

object

Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.

relationships.shipping_method

object

The associated shipping method.

relationships.attachments

array

The associated attachments.

relationships.versions

array

The associated changes.

meta.mode

string

The resource environment (can be one of test or live)

Last updated