The price frequency tier object

A comprehensive list of the price frequency tier resource's attributes and relationships

A price frequency tier object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/price_frequency_tiers endpoint.

Fields

FieldTypeDescription

type

string

price_frequency_tiers

id

string

The price frequency tier unique identifier

links.self

string

The price frequency tier endpoint URL

attributes.created_at

datetime

Time at which the resource was created.

attributes.formatted_price_amount

string

The price of this price tier, formatted.

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.

attributes.name

string

The price tier's name.

attributes.price_amount_cents

integer

The price of this price tier, in cents.

attributes.price_amount_float

float

The price of this price tier, float.

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.up_to

integer

The tier upper limit, expressed as the line item frequency in days (or frequency label, ie 'monthly'). When 'null' it means infinity (useful to have an always matching tier).

attributes.updated_at

datetime

Time at which the resource was last updated.

relationships.attachments

array

The associated attachments.

relationships.events

array

The associated events.

relationships.price

object

The associated price.

relationships.versions

array

The associated changes.

meta.mode

string

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

Last updated