Skip to content

Product Email Settings

Per-product overrides for customer-facing emails. Each key is tri-state: explicitly on, explicitly off, or inherit from the account default.

GET   /v1/settings/products/email?product_id=prd_xxx
PATCH /v1/settings/products/email

Updating requires a paid plan (402 on the free tier).

Get settings

GET /v1/settings/products/email?product_id=prd_xxx
ParameterRequiredDescription
product_idYesProduct ID (query parameter)
json
{
  "data": {
    "overrides": {
      "customer_license_created": false
    },
    "resolved": {
      "customer_license_created": false,
      "customer_license_expiring": true
    }
  }
}
FieldDescription
overridesOnly keys with an explicit per-product on/off; absence means "inherit".
resolvedWhat would actually be sent right now (product override → account default → true).

Update settings

PATCH /v1/settings/products/email
json
{
  "product_id": "prd_xxx",
  "overrides": {
    "customer_license_created": false,
    "customer_license_expiring": null
  }
}
FieldRequiredTypeDescription
product_idYesstringProduct ID
overridesYesobjectMap of key → true / false (set explicit) or null (clear → inherit)

Only customer-facing keys are accepted; unknown keys return 400.

Example

bash
curl -X PATCH "https://api.packedge.dev/v1/settings/products/email" \
  -H "Authorization: Bearer pk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "product_id": "prd_xxx",
    "overrides": { "customer_license_created": false }
  }'