Search…
API Reference
Resources
Coupon recipients
The coupon recipient object and its fields
When creating a coupon, you might want to associate it to a single customer recipient. To do that, you can create a coupon recipient by using the customer email and associate it with the created coupon. When the order has a matching coupon_code, the associated recipient is matched with the email of the customer that placed the order, preventing the application of the discount in case they differ.

The coupon recipient object

A coupon recipient object is returned as part of the response body of each successful list, retrieve, create or update API call.
Field
Type
Description
type
string
coupon_recipients
id
string
The coupon recipient unique identifier
links.self
string
The coupon recipient endpoint URL
attributes.email
string
The recipient email address
attributes.first_name
string
The recipient first name
attributes.last_name
string
The recipient last name
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.customer
object
The associated customer.
relationships.attachments
array
The associated attachments.
meta.mode
string
The resource environment (can be one of test or live)
Last modified 1mo ago