# Offer routes: create, get, list

URL: /code/api/offer/records · Id: `page:code/api/offer/records`

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

Reference for [Offer](/business/nouns/offer), one group of [Offer routes](/code/api/offer).

### Offer.create
Creates an Offer. [Verb page](/business/nouns/offer/create?interface=api).

```text
POST /{namespace}/offers
```

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

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `price` | `money` | Yes | The amount, currency, and unit. Zero is a price. Never randomized. |
| `terms` | `text` | No | The conditions the Customer accepts, refund rights included. Never randomized. |
| `from` | `string` | No | Lineage: the slot it compiles from, as `Hypothesis#<slot>@v<version>`. |
| `activation` | `json` | No | The Event, count and window that mark a Customer activated, such as `Reminder.sent` 20 times within 7 days. |
| `credit` | `money` | No | The Credit Grant each purchase issues, for an Offer that sells prepaid credit, such as $50 of calls. |
| `atBound` | `string` | No | What a call past an Entitlement’s Limit gets: `stop`, `overage` or `upgrade` (refuse it, bill it through the Meter, or move to the next Offer). |
| `interval` | `string` | No | How often it bills: `once`, `day`, `week`, `month` or `year`. |
| `availableFrom` | `datetime` | No | When it can first be bought. Unset: from when it is published. |
| `availableUntil` | `datetime` | No | When it can last be bought. Existing Subscriptions continue past it. |
| `trial` | `json` | No | The free trial every new Customer starts with: `days`, and `card` true to take a card up front. Unset: no trial. |
| `seats` | `string` | No | How a per-seat Price counts: `manual` (the buyer sets the quantity) or `members` (people in the Customer’s Tenant, prorated as they change). |
| `uptime` | `json` | No | The monthly uptime it promises, and the share of that month’s charge credited back below each level. |
| `license` | `string` | No | What a buyer may do with the records it sells: use them `internal`ly, `display` them to its own users, or `redistribute` them. |
| `attribution` | `text` | No | The credit line a buyer shows wherever the records appear. |
| `privateTo` | [Party](/business/nouns/party) | No | The one Party who sees it and may accept it, making it a private Offer; no pricing page lists it. |
| `product` | [Product](/business/nouns/product) | No | Each Offer sells one Product; one Product sits inside many Offers at different prices and terms. |
| `brand` | [Brand](/business/nouns/brand) | No | Each Offer carries exactly one Brand, whose name, voice and logo the buyer sees. |
| `motion` | [Motion](/business/nouns/motion) | No | Each Offer sells through one Motion, which says who buys and who acts for them. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `offer` | [Offer](/business/nouns/offer) | Yes | The Offer. |

**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/offers \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"price":{"amount":29,"currency":"USD"}}'
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "offer": {
    "$id": "https://api.sb/leaseline.app/offers/offer_HNonLXradP",
    "$type": "Offer",
    "price": {
      "amount": 29,
      "currency": "USD"
    }
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Offer.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```

### Offer.get
Returns one Offer by id. [Verb page](/business/nouns/offer/get?interface=api).

```text
GET /{namespace}/offers/{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 Offer. |
| `at` | `string` | No | A time or Version name: the record as it stood then. Unset: as it stands now. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `offer` | [Offer](/business/nouns/offer) | Yes | The Offer. |

**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/offers/offer_2hzYe1ERo0 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Offer",
  "$id": "https://api.sb/leaseline.app/offers/offer_2hzYe1ERo0",
  "offer": {
    "$id": "https://api.sb/leaseline.app/offers/offer_2hzYe1ERo0",
    "$type": "Offer",
    "price": {
      "amount": 29,
      "currency": "USD"
    }
  },
  "links": {
    "self": "https://api.sb/leaseline.app/offers/offer_2hzYe1ERo0",
    "up": "https://api.sb/leaseline.app/offers"
  },
  "actions": {
    "accept": "https://api.sb/leaseline.app/offers/offer_2hzYe1ERo0/accept",
    "grant": "https://api.sb/leaseline.app/offers/offer_2hzYe1ERo0/grant",
    "publish": "https://api.sb/leaseline.app/offers/offer_2hzYe1ERo0/publish"
  }
}
```

### Offer.list
Returns Offers, newest first, one page at a time. [Verb page](/business/nouns/offer/list?interface=api).

```text
GET /{namespace}/offers
```

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 |
| --- | --- | --- | --- |
| `offers` | list of [Offer](/business/nouns/offer) | Yes | One page of Offers. |

**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/offers?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Offer",
  "offers": [
    {
      "$id": "https://api.sb/leaseline.app/offers/offer_2hzYe1ERo0",
      "$type": "Offer",
      "price": {
        "amount": 29,
        "currency": "USD"
      }
    }
  ],
  "meta": {
    "limit": 20,
    "after": "offer_2hzYe1ERo0"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/offers?limit=20",
    "next": "https://api.sb/leaseline.app/offers?after=offer_2hzYe1ERo0"
  }
}
```