The adjustment object
A comprehensive list of the adjustment resource's attributes and relationships
An adjustment object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/adjustments
endpoint.
Fields
Field | Type | Description |
---|---|---|
type |
|
|
id |
| The adjustment unique identifier |
links.self |
| The adjustment endpoint URL |
attributes.amount_cents |
| The adjustment amount, in cents. |
attributes.amount_float |
| The adjustment amount, float. |
attributes.created_at |
| Time at which the resource was created. |
attributes.currency_code |
| The international 3-letter currency code as defined by the ISO 4217 standard. |
attributes.distribute_discount |
| Indicates if negative adjustment amount is distributed for tax calculation. |
attributes.formatted_amount |
| The adjustment amount, formatted. |
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. |
attributes.name |
| The adjustment name. |
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.updated_at |
| Time at which the resource was last updated. |
relationships.versions |
| The associated changes. |
meta.mode |
| The resource environment (can be one of |
Last updated