Skip to main content
GET
/
v1
/
customer_notification_protocol
Retrieve
curl --request GET \
  --url https://{defaultHost}/v1/customer_notification_protocol \
  --header 'Authorization: Bearer <token>'
{
  "id": "43a6fb18-d930-46d6-85ff-88e8f0069768",
  "object": "customer_notification_protocol",
  "free_order_enabled": true,
  "from_name": null,
  "notifications_enabled": true,
  "order_enabled": true,
  "payment_failure_enabled": true,
  "purchase_enabled": true,
  "refund_enabled": true,
  "reply_to_email": "[email protected]",
  "subscription_cancellation_enabled": false,
  "subscription_reminder_enabled": false,
  "subscription_renewal_enabled": false,
  "upsell_accepted_enabled": true,
  "created_at": 1767909690,
  "updated_at": 1767909690
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
free_order_enabled
boolean

Whether or not order confirmation and subscription renewal emails will be sent to customers when the order is free.

​
notifications_enabled
boolean

Whether or not any notifications should be sent to customers. If false no notifications will be sent to customers and all other settings will be ignored.

​
order_enabled
boolean

Whether or not order confirmation emails will be sent to customers.

​
payment_failure_enabled
boolean

Whether or not subscription dunning emails will be sent to customers.

​
purchase_enabled
boolean

Whether or not product access emails will be sent to customers.

​
refund_enabled
boolean

Whether or not refund emails will be sent to customers.

​
subscription_cancellation_enabled
boolean

Whether or not subscription cancellation emails will be sent to customers.

​
subscription_reminder_enabled
boolean

Whether or not subscription reminder emails will be sent to customers.

​
subscription_renewal_enabled
boolean

Whether or not subscription renewal emails will be sent to customers.

​
from_name
string | null

The from name to use when sending emails to customers.

​
reply_to_email
string | null

The reply-to email address to use when sending emails to customers.

​
upsell_accepted_enabled
boolean

Whether or not post purchase offer accepted emails will be sent to customers.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.