Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIFinanceCredit Grant

Credit Grant routes: create, get, list

The Credit Grant Verbs create, get, list as api.sb routes, with inputs, result, refusals and an example.

Reference for Credit Grant, one group of Credit Grant routes.

CreditGrant.create

Creates a Credit Grant. Verb page.

Text
POST /{namespace}/credit-grants

Body, as JSON: the inputs. Emits CreditGrant.created.

Inputs

InputTypeRequiredDescription
amountmoneyrequiredThe balance granted. Never randomized.
categorystringrequiredpaid (bought through an Order, deferred revenue until spent) or promotional (given; never cash). Never randomized.
priorityintegerOrder of use when several grants apply: a lower number spends first, then the earliest expiry.
expiresAtdatetimeWhen any remaining balance lapses. Absent means it never lapses.
appliesToOfferThe metered Offer the balance pays for. Absent means every metered Offer of the Startup.
customerCustomerThe Customer whose metered calls spend the balance; credits never move to another Customer.

Returns

OutputTypeRequiredDescription
creditGrantCredit GrantrequiredThe Credit Grant.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/credit-grants \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"amount":{"amount":29,"currency":"USD"},"category":"paid"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "creditGrant": {
    "$id": "https://api.sb/leaseline.app/credit-grants/credgr_PduV9IB1HF",
    "$type": "CreditGrant",
    "amount": {
      "amount": 29,
      "currency": "USD"
    },
    "category": "paid"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "CreditGrant.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

CreditGrant.get

Returns one Credit Grant by id. Verb page.

Text
GET /{namespace}/credit-grants/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Credit Grant.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
creditGrantCredit GrantrequiredThe Credit Grant.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl https://api.sb/leaseline.app/credit-grants/credgr_PduV9IB1HF \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "CreditGrant",
  "$id": "https://api.sb/leaseline.app/credit-grants/credgr_PduV9IB1HF",
  "creditGrant": {
    "$id": "https://api.sb/leaseline.app/credit-grants/credgr_PduV9IB1HF",
    "$type": "CreditGrant",
    "amount": {
      "amount": 29,
      "currency": "USD"
    },
    "category": "paid"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/credit-grants/credgr_PduV9IB1HF",
    "up": "https://api.sb/leaseline.app/credit-grants"
  },
  "actions": {
    "void": "https://api.sb/leaseline.app/credit-grants/credgr_PduV9IB1HF/void"
  }
}

CreditGrant.list

Returns Credit Grants, newest first, one page at a time. Verb page.

Text
GET /{namespace}/credit-grants

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
creditGrantslist of Credit GrantrequiredOne page of Credit Grants.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl "https://api.sb/leaseline.app/credit-grants?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "CreditGrant",
  "creditGrants": [
    {
      "$id": "https://api.sb/leaseline.app/credit-grants/credgr_PduV9IB1HF",
      "$type": "CreditGrant",
      "amount": {
        "amount": 29,
        "currency": "USD"
      },
      "category": "paid"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "credgr_PduV9IB1HF"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/credit-grants?limit=20",
    "next": "https://api.sb/leaseline.app/credit-grants?after=credgr_PduV9IB1HF"
  }
}

Credit Grant

Previous

apply, issue, void

Next