# void

URL: /business/nouns/credit-grant/void · Id: `verb:CreditGrant.void` · Call: `await $.CreditGrant.void({ … })` (SDK) or the `do` tool at `https://api.sb/mcp`. Inputs says what to pass, Outputs what returns, When it waits who approves.

> Void ends a promotional Credit Grant early and forfeits its remaining balance, keeping the record.

Void ends a promotional [Credit Grant](/business/nouns/credit-grant) early and forfeits its remaining balance, keeping the record.

## Inputs
| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `creditGrant` | [Credit Grant](/business/nouns/credit-grant) | Yes | The grant to end. |
| `reason` | `text` | Yes | Why it ends, shown to the Customer. |

## Outputs
| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `creditGrant` | [Credit Grant](/business/nouns/credit-grant) | Yes | The voided grant, its remaining balance zero. |

## Effects
- Emits [`CreditGrant.voided`](/business/events/CreditGrant.voided).
- Performed by the [Billing Specialist](/agents/finance/billing-specialist).
- One-way (customer): it waits out its delay window, and runs in the `send` and `do` modes.
- Tells the Customer the balance forfeited and why.

## Refuses when
| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | [CreditGrant.void](/business/nouns/credit-grant/void) |

## When it waits
| Gate | Default |
| --- | --- |
| Decision class | Medium: one-way, bounded (customer) |
| [Delay window](/systems/trust-and-governance/controls/one-way-windows) | 1 business hour, in which a watcher can pause, redirect or cancel it; then it runs. |
| Limit | The call [Limit](/business/nouns/limit) of the [Permission](/business/nouns/permission) it runs under. |
| Over the Limit | It waits `pending` for an [Approval](/business/nouns/approval) from the [Founder](/agents/founding/founder). Approved, it runs; refused, it ends `refused` with [`limit-exceeded`](/code/api/errors/limit-exceeded); unanswered by its deadline, it ends `canceled`. |

## Example

**Ask**

```text
Void the latest credit grant.
```

**API**

```bash
curl -X POST https://api.sb/shiftnote.app/credit-grants/credit_grant_1/void \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"Example reason"}'
```

```json
{
  "api": "https://api.sb/shiftnote.app",
  "creditGrant": {
    "$id": "https://api.sb/shiftnote.app/credit-grants/credit_grant_1",
    "$type": "CreditGrant",
    "amount": {
      "amount": 79,
      "currency": "USD"
    },
    "category": "paid"
  },
  "action": {
    "$id": "https://api.sb/shiftnote.app/actions/action_1",
    "operation": "CreditGrant.void",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/shiftnote.app/actions/action_1"
  }
}
```

**SDK**

```ts
import { $ } from 'startup-builder'

const creditGrant = await $.CreditGrant.void({ creditGrant: 'credit_grant_1', reason: 'Example reason' })
```

**CLI**

```bash
npx startup-builder do CreditGrant.void --json '{"creditGrant":"credit_grant_1","reason":"Example reason"}'
```

**MCP**

```json
{
  "name": "do",
  "arguments": {
    "code": "return await $.CreditGrant.void({ creditGrant: 'credit_grant_1', reason: 'Example reason' })"
  }
}
```