# カスタムオブジェクト

Stripe で独自のデータモデルを定義できます。

Custom Objects を使うと、事業の仕組みに合わせて Stripe に独自のデータモデルを定義できます。配送、予約、デバイスなど、Stripe の標準オブジェクトでは表せないデータを、関連する顧客、サブスク、請求などの Stripe データと一緒に管理できます。既存のシステムを管理元として使い続け、Stripe の実装に必要なデータだけを取り込むことも、Custom Objects をデータの正式な管理元にすることもできます。Custom Objects では、次のことができます。

- **Stripe で事業データを定義**: 事業で扱う対象、その関係、ライフサイクルを、型付きのリソースとして表現できます。独自のオブジェクトから、[Customer](https://docs.stripe.com/api/customers/object.md)、[Invoice](https://docs.stripe.com/api/invoices/object.md)、[Subscription](https://docs.stripe.com/api/subscriptions/object.md) などの Stripe オブジェクトを直接参照できます。
- **コードでデータを定義**: TypeScript でオブジェクトを定義し、[Stripe アプリ](https://docs.stripe.com/stripe-apps.md)にまとめます。アプリをアップロードすると、Stripe がオブジェクトの API エンドポイントを作成します。また、定義から型付き SDK を生成できます。
- **データを活用**: レコードを検索し、イベントや [Workflows](https://docs.stripe.com/workflows.md) で変更に対応できます。[Stripe Apps](https://docs.stripe.com/stripe-apps.md) を使えば、ダッシュボードに独自のレコードビューも作成できます。
- **バックエンドを簡素化**: 事業データのためだけに別のデータベースを運用する必要がなくなります。Stripe のデータと事業データを、共通の API で保存、管理できます。

Custom Objects は[プライベートプレビュー](https://docs.stripe.com/release-phases.md)です。

### カスタムオブジェクトの先行提供版にご興味をお持ちですか？

Enter your email to request access.

```bash
curl https://docs.stripe.com/preview/register \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Referer: https://docs.stripe.com/custom-objects" \
  -d '{"email": "EMAIL", "preview": "custom_objects_private_preview"}'
```

## 構築できるもの

Custom Objects は、Stripe の標準オブジェクトに収まらないデータを持つビジネスに適しています。例。

- **ハードウェアのサブスク**: デバイス、その設置場所、ライフサイクルを、請求に使用するサブスクと合わせて管理します。
- **宿泊・ツアー・レンタルの予約**: 予約とゲストの希望を、対応する支払いや請求と合わせて管理します。
- **配送とフルフィルメント**: 配送や配達状況を、対応する請求と合わせて追跡します。
- **顧客からの依頼とフォローアップ**: キャンセルや返金の依頼を追跡し、依頼に伴う Stripe 側の変更を Workflows で行います。
- **Stripe での業務用ダッシュボード**: フルページアプリを作成して、チームがダッシュボードの 1 か所で、レコードと参照先の Stripe オブジェクトを操作できるようにします。

その他の例や、Custom Objects を使用するタイミングのガイダンスについては、[Custom Objects のユースケース](https://docs.stripe.com/custom-objects/use-cases.md)をご覧ください。

## Custom Objects の仕組み

オブジェクトを一度定義すれば、Stripe のさまざまな機能からレコードを操作できます。

1. **オブジェクトの定義**: ビジネスに必要なフィールドを含むオブジェクト定義を作成します。コード内でオブジェクトを定義し、Stripe アプリにパッケージ化します。
2. **レコードの操作**: `/v2/extend/objects/<plural_name>` API を使用して、レコードを作成、取得、更新、一覧取得、検索、および削除します。定義から型付き SDK を生成することもできます。
3. **変更への対応**: オブジェクト定義ごとに、そのレコードが変わるとイベントが送信されます。イベントを使って、ワークフローの開始や他のシステムの更新ができます。
4. **ダッシュボードでの確認**: Stripe ダッシュボードでオブジェクト定義を確認し、レコードを表示、検索、絞り込みできます。

## プライベートプレビューで利用可能な機能

プライベートプレビューでは、以下のことが可能です。

- 型付きフィールド、検証ルール、参照を指定して、Custom Objects をコードで定義し、Stripe アプリにまとめる
- API を通じて、レコードを作成、取得、更新、一覧取得、検索、および削除する
- 定義から型付き Node.js SDK を生成する
- スキーマの変更に合わせて、Custom Objects の定義の新しいバージョンを公開する
- 各オブジェクト定義について、そのレコードの変更時にイベントを受信する
- Workflows で Custom Objects を使用し、トリガーとして利用したり、レコードを作成・更新するステップとして利用したりする
- Stripe Apps を使用して、レコードのダッシュボードビューとフルページアプリを構築する
- ダッシュボードでオブジェクト定義を確認し、レコードの表示、検索、絞り込みを行う (プライベートプレビュー期間中のダッシュボードは読み取り専用)

プライベートプレビュー期間中は、Custom Objects を単一の Stripe アカウント内で使用できます。アカウント間では共有できません。その他の制約については、[制限と制約](https://docs.stripe.com/custom-objects/limitations.md)をご覧ください。

## 次のステップ

- [Custom Objects の仕組み](https://docs.stripe.com/custom-objects/how-it-works.md)
- [Custom Objects の利用を開始する](https://docs.stripe.com/custom-objects/get-started.md)
- [Custom Objects を定義する](https://docs.stripe.com/custom-objects/define.md)
