comecerodocs
Notification subscriptions

Get a notification subscription

GET
/notification_subscriptions/{notification_subscription_id}

Gets one notification subscription. Secret and trusted tokens may call it; a limited token may not (403).

Authorization

headerAuthorizationBearer <token>

A secret, trusted or limited token. See Authentication.

Path Parameters

notification_subscription_id*string

The notification subscription id.

Query Parameters

timezone?string

An IANA time zone name, such as America/New_York or UTC. It sets how date_start and date_end are read and the time zone of every date in the response. The default is the account's time zone (Settings, Technical), or UTC when it has none. A name that is not known is a 400.

expand?string

Comma-separated child objects to return in full instead of as a URL, for example customer,payments. Use dot notation for nested objects (items.product), up to four levels deep. A single object takes up to 12 paths; a list takes up to 2, applied to every item. Extra paths are dropped without an error. See Expanding objects.

show?string

Comma-separated fields to return; all others are left out. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

hide?string

Comma-separated fields to leave out of the response. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

formatted?boolean

When true, the object also has a formatted child with amounts and dates as display text in the shopper's language and currency (for example $19.99 or November 7, 2026). The default is false. See Localized formatting.

Defaultfalse

Response Body

The notification subscription.

application/json
  1. response

Turns on one kind of customer email and sets who it comes from, its subject and its template. Only one subscription per type may be active.

object?"notification_subscription"

Always notification_subscription.

Value in"notification_subscription"
url?string

The URL of this notification subscription in the API.

Formaturi
notification_subscription_id?string

The notification subscription id.

date_created?string

When it was created.

Formatdate-time
date_modified?string

When it last changed.

Formatdate-time
test?boolean

true for a test mode subscription. It only sends test mode emails.

type?notification_type

The kind of customer email. order:confirmation (receipt for a new order), payment:confirmation, refund:confirmation, shipment:confirmation, cart:link and invoice:link (a link to pay), customer:link (a link to the customer's account), subscription:prebill_notification (a renewal is coming), subscription:cancel_confirmation and subscription:payment_failure (a renewal payment failed).

Value in"order:confirmation""shipment:confirmation""payment:confirmation""refund:confirmation""cart:link""invoice:link""customer:link""subscription:prebill_notification""subscription:cancel_confirmation""subscription:payment_failure"
active?boolean

Whether the email is sent. On create the default is false.

account_id?string

The account it belongs to.

method?"email"

How to send. Only email.

Value in"email"
from?|

The sender address, one of your verified notification addresses. When null, emails go from notification@comecero.com.

from_name?|

The sender name, at most 25 characters. When null, your public company name.

reply_to?|

The reply-to address. When null and emails go from Comecero's address, your support email is used.

bcc?|

Up to 4 addresses, comma-separated, that get a blind copy of every email.

subject?|

The subject line, at most 75 characters. It may hold placeholders such as {{order.order_id}}. When null, the template's default subject is used, then a built-in one.

template?||

Your template for the body: its URL, the full object with expand=template, or null to use Comecero's built-in template (in the customer's language where one exists). Left out when the token may not read templates.

comments?|

Your own notes, at most 256 characters.

formatted?

Dates as display text. Only returned with formatted=true.

Example Request
curl -X GET 'https://api.comecero.com/api/v1/notification_subscriptions/string'
Example Response
{  "object": "notification_subscription",  "url": "https://api.comecero.com/api/v1/notification_subscriptions/1102500112233NSd4Kw9Tz",  "notification_subscription_id": "1102500112233NSd4Kw9Tz",  "date_created": "2026-10-01T09:00:00Z",  "date_modified": "2026-10-01T09:00:00Z",  "test": true,  "type": "shipment:confirmation",  "active": true,  "account_id": "AB1234",  "method": "email",  "from": null,  "from_name": "Example Shop",  "reply_to": "support@example.com",  "bcc": null,  "subject": "Your order {{order.order_id}} has shipped",  "template": null,  "comments": null}

Create a notification subscription POST

Turns on one kind of customer email, such as the shipment confirmation. Send `active: true`, because a new subscription is inactive by default. Only one subscription per type may be active (`409`). A `from` address that is not verified is refused (`422`). Secret and trusted tokens may call it; a limited token may not (`403`).

Update a notification subscription POST

Changes the fields you send and leaves the others as they are. An empty string clears a field. Send `template_id: null` to go back to the built-in template. When you send `active: true` together with `type`, also send `notification_subscription_id` in the body, or the check for a second active subscription of that type counts this one and answers `409`. Secret and trusted tokens may call it; a limited token may not (`403`).