Adjustments are arbitrary objects that can be used to change the total amount of an order by any value, either greater or lower than zero. To add an adjustment to an order, you first need to create the adjustment and then create a line item that references it.
An adjustment object is returned as part of the response body of each successful create, list, retrieve, or update API call.
Field | Type | Description |
type |
|
|
id |
| The adjustment unique identifier |
links.self |
| The adjustment endpoint URL |
attributes.name |
| The adjustment name |
attributes.currency_code |
| The international 3-letter currency code as defined by the ISO 4217 standard. |
attributes.amount_cents |
| The adjustment amount, in cents. |
attributes.amount_float |
| The adjustment amount, float. |
attributes.formatted_amount |
| The adjustment amount, formatted. |
attributes.created_at |
| Time at which the resource was created. |
attributes.updated_at |
| Time at which the resource was last updated. |
attributes.reference |
| 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 |
| Any identifier of the third party system that defines the reference code |
attributes.metadata |
| 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. |
meta.mode |
| The resource environment (can be one of |