BrainerceRead the newsletter signup benefit
The offer to show beside a newsletter signup field: the discount, how long the coupon lasts, any minimum order, whether it is limited to a first order, and the merchant-written headline and terms.
Returns null when the store offers no benefit — render the plain signup form in that case, and do not promise anything.
Show these terms on the form, then post to /marketing/subscribe. The coupon does not exist yet at that point: it is created only when the shopper clicks the link in the confirmation email, and it is then emailed to them. Tell them to check their inbox rather than telling them they have a coupon.
Carries no information about any individual and accepts no email address, so it cannot be used to check whether someone has already subscribed or already claimed a benefit.
For /api/vc/{connectionId}/* routes the connectionId (vc_*) is in the URL path — not a header. Live-mode requests must also send a matching Origin header.
In: header
Path Parameters
Sales channel ID (vc_*), the canonical salesChannelId. connectionId is the deprecated name of the same value and is still the literal path segment.
Query Parameters
Language code, for example he. Used only when no Accept-Language header is sent. A language the store does not support, or the store's default language, returns the default text.
Header Parameters
Origin of the storefront page making the call, for example https://shop.example.com. Required: a request with no Origin header is refused with 403. On a LIVE channel its host must equal the channel's registered domain (or one of its subdomains) or match an allowed origin. A TEST channel with no domain accepts any origin; once a domain is set it is matched as on LIVE.
Preferred language, for example he. Its first tag is used when it is one of the store's supported languages other than the default; translated fields are then returned in that language. Falls back to the locale query parameter.
Version of the calling SDK (the Brainerce SDK sends it automatically). Informational: it is recorded on the channel and never changes the response.
curl -X GET "https://api.brainerce.com/api/vc/string/newsletter-benefit?locale=string" \ -H "origin: string" \ -H "accept-language: string" \ -H "X-SDK-Version: string"{
"enabled": true,
"discountType": "PERCENTAGE",
"discountValue": 10,
"validityDays": 30,
"minimumOrderAmount": 0,
"maximumDiscount": 0,
"firstOrderOnly": true,
"headline": "string",
"terms": "string"
}{
"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/vc/{connectionId}/newsletter-benefit"
}{
"statusCode": 404,
"code": "RESOURCE_NOT_FOUND",
"message": "Resource not found",
"timestamp": "2026-08-23T10:15:00.000Z",
"path": "/api/vc/{connectionId}/newsletter-benefit"
}{
"statusCode": 429,
"code": "RATE_LIMITED",
"message": "Too many requests",
"details": {
"retryAfterSeconds": 12
},
"timestamp": "2026-08-23T10:15:00.000Z",
"path": "/api/vc/{connectionId}/newsletter-benefit"
}