# Credit Grant routes: create, get, list

URL: /code/api/credit-grant/records · Id: `page:code/api/credit-grant/records`

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

Reference for [Credit Grant](/business/nouns/credit-grant), one group of [Credit Grant routes](/code/api/credit-grant).

### CreditGrant.create
Creates a Credit Grant. [Verb page](/business/nouns/credit-grant/create?interface=api).

```text
POST /{namespace}/credit-grants
```

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

**Inputs**

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

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `creditGrant` | [Credit Grant](/business/nouns/credit-grant) | Yes | The Credit Grant. |

**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. | None. |

**Example**

```bash
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](/business/nouns/credit-grant/get?interface=api).

```text
GET /{namespace}/credit-grants/{id}
```

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

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | The id of the Credit Grant. |
| `at` | `string` | No | A time or Version name: the record as it stood then. Unset: as it stands now. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `creditGrant` | [Credit Grant](/business/nouns/credit-grant) | Yes | The Credit Grant. |

**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. | None. |

**Example**

```bash
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](/business/nouns/credit-grant/list?interface=api).

```text
GET /{namespace}/credit-grants
```

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

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | `integer` | No | At most this many records, up to 100. The default is 20. |
| `after` | `string` | No | The cursor from the previous page. |
| `where` | `string` | No | A filter over the properties, such as `paidAt = null and total.amount > 500`. |
| `sort` | `string` | No | Properties to sort by, comma-separated; a leading minus sorts descending. |
| `total` | `boolean` | No | True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above. |
| `facets` | `string` | No | Properties to count by value, comma-separated, returned as `meta.facets`. |
| `fields` | `string` | No | Properties to return on each record, comma-separated; `$id` and `$type` always return. |
| `include` | `string` | No | Related records to embed in place of their URLs, comma-separated. |
| `depth` | `integer` | No | How many levels of related records to embed. The default is 1. |
| `q` | `string` | No | Words to match across the text properties, ranked by relevance. |
| `match` | `string` | No | Ranks the search by `words`, or `meaning`; words is the default. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `creditGrants` | list of [Credit Grant](/business/nouns/credit-grant) | Yes | One page of Credit Grants. |

**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. | None. |

**Example**

```bash
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"
  }
}
```