contracts.add_granted_credit

What it does

Add a right to a vendor contract for credit the vendor grants, such as a startup program’s. It joins the credit pool that already pays the eligible rights, or starts one. Record each grant or tranche afterwards with contracts.record, phase exercise, with facts face and expiresAt.

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 contracts.add_granted_credit through GET /v1/catalog/commands/{name} before acting.

The envelope may reference a registered source document of kind contract, source_document; this is separate from any evidence required by the input.

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.

Field	Type	Required	Meaning and accepted values
`contractId`	string	Yes	Minimum length: `1`. Example: `"ctr_example"`.
`expectedDocumentId`	string	Yes	Minimum length: `1`. Example: `"doc_contract"`.
`effectiveAt`	string	Yes	Format: date-time. Minimum length: `1`. Example: `"2026-09-10T00:00:00Z"`.
`key`	string	Yes	Minimum length: `1`. Example: `"startup_credit"`.
`name`	string	Yes	Minimum length: `1`. Example: `"Startup program credit"`.
`eligibleRights`	array	Yes	Items: string. Minimum items: `1`. Maximum items: `100`.
`coverageBps`	string	No	Pattern: `"^[1-9][0-9]{0,4}$"`.
`sourceDocumentIds`	array	No	Items: string. Maximum items: `100`.
`evidence`	array	Yes	Items: object. Minimum items: `1`. Maximum items: `20`.
`evidence[].kind`	string	Yes	Choose `"tap_message"`, `"x402_receipt"`, `"chain_tx"`, `"signed_doc"`, `"stripe_object"`, `"other"`. Example: `"other"`.
`evidence[].ref`	string	Yes	Minimum length: `1`. Example: `"doc_grant_email"`.
`evidence[].signer`	string	No	Minimum length: `1`.

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

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

Field	Type	Required	Meaning and accepted values
`id`	string	Yes	Minimum length: `1`.
`documentId`	string	Yes	Minimum length: `1`.
`cid`	string	Yes	Minimum length: `1`.
`poolKey`	string	Yes	Minimum length: `1`.

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": "contracts.add_granted_credit"
    },
    "input": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "contractId",
        "expectedDocumentId",
        "effectiveAt",
        "key",
        "name",
        "eligibleRights",
        "evidence"
      ],
      "properties": {
        "contractId": {
          "type": "string",
          "minLength": 1
        },
        "expectedDocumentId": {
          "type": "string",
          "minLength": 1
        },
        "effectiveAt": {
          "type": "string",
          "minLength": 1,
          "format": "date-time"
        },
        "key": {
          "type": "string",
          "minLength": 1
        },
        "name": {
          "type": "string",
          "minLength": 1
        },
        "eligibleRights": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          },
          "minItems": 1,
          "maxItems": 100
        },
        "coverageBps": {
          "type": "string",
          "pattern": "^[1-9][0-9]{0,4}$"
        },
        "sourceDocumentIds": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          },
          "maxItems": 100
        },
        "evidence": {
          "type": "array",
          "minItems": 1,
          "maxItems": 20,
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "kind",
              "ref"
            ],
            "properties": {
              "kind": {
                "enum": [
                  "tap_message",
                  "x402_receipt",
                  "chain_tx",
                  "signed_doc",
                  "stripe_object",
                  "other"
                ]
              },
              "ref": {
                "type": "string",
                "minLength": 1
              },
              "signer": {
                "type": "string",
                "minLength": 1
              }
            }
          }
        }
      }
    },
    "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))$"
    },
    "source_document_id": {
      "description": "A registered document of kind contract, source_document that caused this command.",
      "type": "string",
      "minLength": 1
    }
  },
  "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",
      "required": [
        "id",
        "documentId",
        "cid",
        "poolKey"
      ],
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1
        },
        "documentId": {
          "type": "string",
          "minLength": 1
        },
        "cid": {
          "type": "string",
          "minLength": 1
        },
        "poolKey": {
          "type": "string",
          "minLength": 1
        }
      }
    },
    "events": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "cid": {
            "type": "string"
          }
        }
      }
    }
  }
}

Example request

{
  "name": "contracts.add_granted_credit",
  "input": {
    "contractId": "ctr_example",
    "expectedDocumentId": "doc_contract",
    "effectiveAt": "2026-09-10T00:00:00Z",
    "key": "startup_credit",
    "name": "Startup program credit",
    "eligibleRights": [
      "api_usage"
    ],
    "evidence": [
      {
        "kind": "other",
        "ref": "doc_grant_email"
      }
    ]
  },
  "effective_at": "2026-09-01T00:00:00Z",
  "idempotency_key": "contracts.add_granted_credit-example-0"
}