BrainerceRead the active newsletter signup benefit
The offer to show beside a newsletter signup field: discount, validity, minimum order, whether it is first-order only, and the merchant-written headline and terms.
Returns null when no benefit is active — render the plain signup form in that case.
Carries no information about any individual and accepts no email address, so it cannot be used to test whether someone has already subscribed or claimed. Tell the shopper the terms shown here, then post to /marketing/subscribe; the coupon only exists after they click the link in the confirmation email.
Path Parameters
ID of the store whose signup benefit is read.
Query Parameters
Preferred language for the headline and terms, as a language code such as he or en-US (only the part before the dash is used). Falls back to the store language, then to en; when none of them has copy, headline and terms are null.
curl -X GET "https://api.brainerce.com/api/stores/clx1a2b3c4d5e6f7g8h9/newsletter-benefit?locale=he"{
"enabled": true,
"discountType": "PERCENTAGE",
"discountValue": 10,
"validityDays": 30,
"minimumOrderAmount": 100,
"maximumDiscount": 50,
"firstOrderOnly": true,
"headline": "Get 10% off your first order",
"terms": "Valid for 30 days. Minimum order 100."
}{
"statusCode": 403,
"code": "INSUFFICIENT_SCOPE",
"message": "API key does not have the required scope: products:write",
"timestamp": "2026-08-23T10:15:00.000Z",
"path": "/api/stores/{storeId}/newsletter-benefit"
}{
"statusCode": 429,
"code": "RATE_LIMITED",
"message": "Too many requests",
"details": {
"retryAfterSeconds": 12
},
"timestamp": "2026-08-23T10:15:00.000Z",
"path": "/api/stores/{storeId}/newsletter-benefit"
}