# The price frequency tier object

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

| Field                                   | Type       | Description                                                                                                                                                                                         |
| --------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **type**                                | `string`   | `price_frequency_tiers`                                                                                                                                                                             |
| **id**                                  | `string`   | The price frequency tier unique identifier                                                                                                                                                          |
| links.**self**                          | `string`   | The price frequency tier endpoint URL                                                                                                                                                               |
| attributes.**name**                     | `string`   | The price tier's name.                                                                                                                                                                              |
| 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.**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.**formatted\_price\_amount** | `string`   | The price of this price 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.**price**                 | `object`   | The associated price.                                                                                                                                                                               |
| relationships.**attachments**           | `array`    | The associated attachments.                                                                                                                                                                         |
| relationships.**versions**              | `array`    | The associated changes.                                                                                                                                                                             |
| relationships.**event\_stores**         | `array`    | The associated event stores.                                                                                                                                                                        |
| relationships.**events**                | `array`    | The associated events.                                                                                                                                                                              |
| meta.**mode**                           | `string`   | The resource environment (can be one of `test` or `live`)                                                                                                                                           |