The in stock subscription object
A comprehensive list of the in stock subscription resource's attributes and relationships
An in stock subscription object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/in_stock_subscriptions
endpoint.
Fields
Field | Type | Description |
---|---|---|
type |
|
|
id |
| The in stock subscription unique identifier |
links.self |
| The in stock subscription endpoint URL |
attributes._activate |
| Send this attribute if you want to activate an inactive subscription. |
attributes._deactivate |
| Send this attribute if you want to dactivate an active subscription. |
attributes.created_at |
| Time at which the resource was created. |
attributes.customer_email |
| The email of the associated customer, replace the relationship. |
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.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.sku_code |
| The code of the associated SKU, replace the relationship. |
attributes.status |
| The subscription status. One of 'active' (default), 'inactive', or 'notified'. |
attributes.stock_threshold |
| The threshold at which to trigger the back in stock notification. |
attributes.updated_at |
| Time at which the resource was last updated. |
relationships.customer |
| The associated customer. |
relationships.events |
| The associated events. |
relationships.market |
| The associated market. |
relationships.sku |
| The associated SKU. |
relationships.versions |
| The associated changes. |
meta.mode |
| The resource environment (can be one of |
Last updated