Customer subscriptions
Customer subscriptions are simple resources that you can use to track newsletter registrations. Populate the reference with any key that makes sense to your business domain. Send the subscriptions to any third party tool or CRM for marketing and segmentation. Let the customers manage their active subscriptions through their reserved area.
A customer subscription 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 customer subscription unique identifier |
links.self |
| The customer subscription endpoint URL |
attributes.customer_email |
| The email of the customer that owns the subscription |
attributes.id |
| Unique identifier for the resource (hash). |
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 your own identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool or a CRM. |
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. |
relationships.customer |
| The associated customer. |
meta.mode |
| The resource environment (can be one of |
