concessions.create_offer

What it does

Create a concession offer: a discount the business gives customers off what their agreement would otherwise charge, with its purpose (acquisition, retention, service or research) and attribution (a campaign name, a partner party). Assign it to emails with concessions.assign; a contract takes it with contracts.create’s concession. Posts nothing.

Before you send it

An authorized OAuth connection may call it, including a headless client. Effective membership, application grant and token permissions still apply. Describe concessions.create_offer through GET /v1/catalog/commands/{name} before acting.

This command does not accept source_document_id in its envelope. Any input evidence requirements remain as documented below.

Inputs

Put these fields inside the envelope’s input object. The outer envelope names the command, a stable idempotency_key and effective_at; request and recovery rules explain those separately. Use exact minor-unit integer strings for monetary fields. Take existing IDs from prior reads or command results; choose a new identity only where the command asks for one.

Required means required within its containing object; an optional parent can be omitted.

FieldTypeRequiredMeaning and accepted values
namestringYesMinimum length: 1. Maximum length: 200. Example: "Design partner free year".
purposestringYesChoose "acquisition", "retention", "service", "research". Example: "research".
campaignstringNoMinimum length: 1. Maximum length: 200. Example: "design partners".
partnerPartyIdstringNoMinimum length: 1. Maximum length: 200.
partnerContractIdstringNoMinimum length: 1. Maximum length: 200.
discountobjectYes
discount.basisPointsintegerNoMinimum: 1. Maximum: 10000. Example: 10000.
discount.amountstringNoPattern: "^[1-9][0-9]*$".
discount.monthsintegerNoMinimum: 1. Maximum: 1200. Example: 12.
maxRedemptionsintegerNoMinimum: 1. Maximum: 1000000.
emailsarrayNoItems: string. Maximum items: 50.
codestringNoMinimum length: 2. Maximum length: 40.
systemstringNoMinimum length: 2. Maximum length: 40.
validFromstringNoFormat: date.
validUntilstringNoFormat: date.
eligibilityobjectNo
eligibility.emailDomainstringNoMinimum length: 1. Maximum length: 200.

After acceptance

When the command emits events, its documented effects and receipt are recorded in the command transaction. The response returns commandId, replayed, the command-specific result below and emitted events with their IDs and CIDs. A command is not automatically a cash movement or revenue recognition: use the behavior above to determine what this command records.

Inspect result and the affected records or reports before continuing. Save returned identifiers for later calls. Fetch GET /v1/commands/{id} with commandId to recover the accepted receipt; retry the same intent with the same idempotency key if the response was lost. Some commands can succeed with events: [] and return a transient result and commandId without persisting a receipt. A lookup of that ID can return null; retain the returned result and verify the affected record. Retrying can re-evaluate the current state rather than replay a stored result. A domain no_change is a separate success outcome with no persisted receipt.

Result fields

See the exact schema below for the accepted shape.

All commands · Operation and errors · Reusable schemas

Keep credentials out of prompts; rehearse writes only in a disposable sandbox.

Exact request schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "const": "concessions.create_offer"
    },
    "input": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "purpose": {
          "enum": [
            "acquisition",
            "retention",
            "service",
            "research"
          ]
        },
        "campaign": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "partnerPartyId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "partnerContractId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "discount": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "basisPoints": {
              "type": "integer",
              "minimum": 1,
              "maximum": 10000
            },
            "amount": {
              "type": "string",
              "pattern": "^[1-9][0-9]*$"
            },
            "months": {
              "type": "integer",
              "minimum": 1,
              "maximum": 1200
            }
          },
          "required": []
        },
        "maxRedemptions": {
          "type": "integer",
          "minimum": 1,
          "maximum": 1000000
        },
        "emails": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 3,
            "maxLength": 320
          },
          "maxItems": 50
        },
        "code": {
          "type": "string",
          "minLength": 2,
          "maxLength": 40
        },
        "system": {
          "type": "string",
          "minLength": 2,
          "maxLength": 40
        },
        "validFrom": {
          "type": "string",
          "format": "date"
        },
        "validUntil": {
          "type": "string",
          "format": "date"
        },
        "eligibility": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "emailDomain": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            }
          },
          "required": []
        }
      },
      "required": [
        "name",
        "purpose",
        "discount"
      ]
    },
    "idempotency_key": {
      "type": "string",
      "minLength": 1,
      "maxLength": 256
    },
    "effective_at": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
    }
  },
  "required": [
    "name",
    "input",
    "idempotency_key",
    "effective_at"
  ],
  "additionalProperties": false
}

Accepted command receipt

{
  "type": "object",
  "required": [
    "commandId",
    "replayed",
    "result",
    "events"
  ],
  "properties": {
    "commandId": {
      "type": "string"
    },
    "replayed": {
      "type": "boolean"
    },
    "imported": {
      "const": true,
      "description": "The command's events are history from before the business joined Economico, recorded as an import: free of monthly events."
    },
    "result": {
      "type": "object"
    },
    "events": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "cid": {
            "type": "string"
          }
        }
      }
    }
  }
}

Example request

{
  "name": "concessions.create_offer",
  "input": {
    "name": "Design partner free year",
    "purpose": "research",
    "campaign": "design partners",
    "discount": {
      "basisPoints": 10000,
      "months": 12
    }
  },
  "effective_at": "2026-09-01T00:00:00Z",
  "idempotency_key": "concessions.create_offer-example-0"
}
Navigate documentation

On this page