Skip to content

by Startups.Studio

Finance Credit Grant

CreditGrant.create

POST /{namespace}/credit-grants

Creates a Credit Grant.

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

You, to your agent

Add a credit grant to PatentPad.

curl -X POST https://api.sb/patentpad.com/credit-grants \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"amount":{"amount":499,"currency":"USD"},"category":"paid"}'

import { $ } from 'startup-builder'

const creditGrant = await $.CreditGrant.create({ amount: { amount: 499, currency: 'USD' }, category: 'paid' })

npx startup-builder do CreditGrant.create --json '{"amount":{"amount":499,"currency":"USD"},"category":"paid"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.CreditGrant.create({ amount: { amount: 499, currency: 'USD' }, category: 'paid' })"
  }
}

Create makes a new Credit Grant from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`amount`	`money`	required	The balance granted. Never randomized.
`category`	`string`	required	`paid` (bought through an Order, deferred revenue until spent) or `promotional` (given; never cash). Never randomized.
`priority`	`integer`		Order of use when several grants apply: a lower number spends first, then the earliest expiry.
`expiresAt`	`datetime`		When any remaining balance lapses. Absent means it never lapses.
`appliesTo`	Offer		The metered Offer the balance pays for. Absent means every metered Offer of the Startup.
`customer`	Customer		The Customer whose metered calls spend the balance; credits never move to another Customer.

Outputs

Output	Type	Required	Description
`creditGrant`	Credit Grant	required	The Credit Grant.

Effects

Emits CreditGrant.created.
Two-way: try, send, do.

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.create

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
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.apply

Previous Page

CreditGrant.get

Next Page