Skip to content

by Startups.Studio

Finance Credit Grant

CreditGrant.void

POST /{namespace}/credit-grants/{creditGrant}/void

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

Noun: Credit Grant
Mode: do
Event: CreditGrant.voided

You, to your agent

Void the latest credit grant.

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"}'

import { $ } from 'startup-builder'

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

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

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

Inputs

Input	Type	Required	Description
`creditGrant`	Credit Grant	required	The grant to end.
`reason`	`text`	required	Why it ends, shown to the Customer.

Outputs

Output	Type	Required	Description
`creditGrant`	Credit Grant	required	The voided grant, its remaining balance zero.

Effects

Emits CreditGrant.voided.
Performed by the 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`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	CreditGrant.void

When it waits

Gate	Default
Decision class	Medium: one-way, bounded (customer)
Delay window	1 business hour, in which a watcher can pause, redirect or cancel it; then it runs.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

CreditGrant.list

Previous Page

Entitlement

Next Page