# Payment Source methods: get, list, update

URL: /code/sdk/payment-source/records · Id: `page:code/sdk/payment-source/records`

> The Payment Source Verbs get, list, update as typed SDK methods, with inputs, result, refusals and an example.

Reference for [Payment Source](/business/nouns/payment-source), one group of [Payment Source methods](/code/sdk/payment-source).

### PaymentSource.get
Returns one Payment Source by id. [Verb page](/business/nouns/payment-source/get?interface=sdk).

```ts
interface PaymentSourceVerbs {
  get(input: PaymentSourceGetInput, options?: SB.CallOptions): SB.Call<PaymentSource>
}
```

Reads only: it emits no Event.

**Inputs**

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

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `paymentSource` | [Payment Source](/business/nouns/payment-source) | Yes | The Payment Source. |

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

```ts
import { $ } from 'startup-builder'

const paymentSource = await $.PaymentSource.get({ id: 'pm_puFT0MuuUM' })
```

### PaymentSource.list
Returns Payment Sources, newest first, one page at a time. [Verb page](/business/nouns/payment-source/list?interface=sdk).

```ts
interface PaymentSourceVerbs {
  list(input?: PaymentSourceListInput, options?: SB.CallOptions): SB.ListCall<PaymentSource>
}
```

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 |
| --- | --- | --- | --- |
| `paymentSources` | list of [Payment Source](/business/nouns/payment-source) | Yes | One page of Payment Sources. |

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

```ts
import { $ } from 'startup-builder'

const paymentSources = await $.PaymentSource.list({ limit: 20 })
```

### PaymentSource.update
Changes the given properties of a Payment Source. [Verb page](/business/nouns/payment-source/update?interface=sdk).

```ts
interface PaymentSourceVerbs {
  update(input: PaymentSourceUpdateInput, options?: SB.CallOptions): SB.Call<PaymentSource>
}
```

Emits `PaymentSource.updated`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | The id of the Payment Source. |
| `kind` | `string` | No | How it pays: a card, a bank debit from the Customer’s account, or a wallet on the Customer’s phone or browser. |
| `label` | `string` | No | What the Customer sees, such as the card brand and last four digits; never the full number. |
| `expiresOn` | `date` | No | When a card expires; the billing portal asks for a new one 30 days before. |
| `default` | `boolean` | No | True for the one Payment Source that new Invoices and renewals charge. |
| `removedAt` | `datetime` | No | When the Customer removed it; nothing charges it after, and the record stays. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `paymentSource` | [Payment Source](/business/nouns/payment-source) | Yes | The Payment Source. |

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

```ts
import { $ } from 'startup-builder'

const paymentSource = await $.PaymentSource.update({ id: 'pm_puFT0MuuUM', kind: 'card' })
```