@payjp/payjpv2 1.0.2 → 1.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. package/dist/index.cjs +2 -1
  2. package/dist/index.cjs.map +1 -1
  3. package/dist/index.d.cts +742 -607
  4. package/dist/index.d.cts.map +1 -1
  5. package/dist/index.d.mts +742 -607
  6. package/dist/index.d.mts.map +1 -1
  7. package/dist/index.mjs +2 -1
  8. package/dist/index.mjs.map +1 -1
  9. package/package.json +1 -1
package/dist/index.d.mts CHANGED
@@ -355,7 +355,7 @@ type BalanceResponse = {
355
355
  /**
356
356
  * Id
357
357
  *
358
- * 残高ID
358
+ * 残高 ID
359
359
  */
360
360
  id: string;
361
361
  /**
@@ -365,21 +365,9 @@ type BalanceResponse = {
365
365
  */
366
366
  livemode: boolean;
367
367
  /**
368
- * Created At
369
- *
370
- * 作成日時 (UTC, ISO 8601 形式)
371
- */
372
- created_at: string;
373
- /**
374
- * Updated At
375
- *
376
- * 更新時の日時 (UTC, ISO 8601 形式)
377
- */
378
- updated_at: string;
379
- /**
380
- * Balanceの状態
368
+ * Balance の状態
381
369
  *
382
- * | 指定できる値 |
370
+ * | 値 |
383
371
  * |:---|
384
372
  * | **collecting**: 集計中 |
385
373
  * | **transfer**: 入金 |
@@ -389,15 +377,15 @@ type BalanceResponse = {
389
377
  /**
390
378
  * Statements
391
379
  *
392
- * 関連付けられているStatementオブジェクトのリスト
380
+ * 関連付けられている Statement オブジェクトのリスト
393
381
  */
394
382
  statements: Array<StatementResponse>;
395
383
  /**
396
384
  * Closed
397
385
  *
398
- * このBalanceの清算が終了していればtrue
386
+ * この Balance の清算が終了していれば true
399
387
  *
400
- * state=transferであれば加盟店口座への入金作業完了、state=claimであればPAY.JPで請求額の振込が確認できたことを表します。
388
+ * state=transfer であれば加盟店口座への入金作業完了、state=claim であれば PAY.JP で請求額の振込が確認できたことを表します。
401
389
  */
402
390
  closed: boolean;
403
391
  /**
@@ -405,7 +393,7 @@ type BalanceResponse = {
405
393
  *
406
394
  * 精算が終了した日時 (UTC, ISO 8601 形式)
407
395
  *
408
- * state=transferであれば着金予定日、state=claimであれば振込が確認できた日時を表します。
396
+ * state=transfer であれば着金予定日、state=claim であれば振込が確認できた日時を表します。
409
397
  */
410
398
  closed_date: string | null;
411
399
  /**
@@ -413,19 +401,31 @@ type BalanceResponse = {
413
401
  *
414
402
  * 入金予定日/請求期限日 (UTC, ISO 8601 形式)
415
403
  *
416
- * state=transferであれば入金予定日、state=claimであれば請求の期限日を表します。
404
+ * state=transfer であれば入金予定日、state=claim であれば請求の期限日を表します。
417
405
  */
418
406
  due_date: string | null;
419
407
  /**
420
408
  * Net
421
409
  *
422
- * 関連付けられているStatementの総額
410
+ * 関連付けられている Statement の総額
423
411
  */
424
412
  net: number;
425
413
  /**
426
414
  * 銀行口座情報
427
415
  */
428
416
  bank_info: BankInfoResponse | null;
417
+ /**
418
+ * Created At
419
+ *
420
+ * 作成日時 (UTC, ISO 8601 形式)
421
+ */
422
+ created_at: string;
423
+ /**
424
+ * Updated At
425
+ *
426
+ * 更新時の日時 (UTC, ISO 8601 形式)
427
+ */
428
+ updated_at: string;
429
429
  };
430
430
  /**
431
431
  * BalanceState
@@ -444,13 +444,13 @@ type BalanceUrlResponse = {
444
444
  /**
445
445
  * Url
446
446
  *
447
- * 残高明細書ダウンロードURL
447
+ * 残高明細書ダウンロード URL
448
448
  */
449
449
  url: string;
450
450
  /**
451
451
  * Expires
452
452
  *
453
- * 有効期限の日付。
453
+ * 有効期限の日付
454
454
  *
455
455
  * 有効期限は発行から1時間です。
456
456
  */
@@ -495,7 +495,7 @@ type BankInfoResponse = {
495
495
  *
496
496
  * 最新振込結果
497
497
  *
498
- * | 指定できる値 |
498
+ * | 値 |
499
499
  * |:---|
500
500
  * | **success**: 成功 |
501
501
  * | **failed**: 失敗 |
@@ -512,7 +512,7 @@ type CaptureMethod = 'automatic' | 'manual';
512
512
  */
513
513
  type CardConfigRequest = {
514
514
  /**
515
- * 支払い方法の表示設定。
515
+ * 支払い方法の表示設定
516
516
  */
517
517
  display_preference?: DisplayPreferenceRequest | null;
518
518
  };
@@ -520,6 +520,15 @@ type CardConfigRequest = {
520
520
  * CheckoutSessionCreateRequest
521
521
  */
522
522
  type CheckoutSessionCreateRequest = {
523
+ /**
524
+ * Checkout Session のモード
525
+ *
526
+ * | 指定できる値 |
527
+ * |:---|
528
+ * | **payment**: 支払いモードで Checkout Session を作成します。 |
529
+ * | **setup**: セットアップモードで Checkout Session を作成します。 |
530
+ */
531
+ mode: CheckoutSessionMode;
523
532
  /**
524
533
  * Client Reference Id
525
534
  *
@@ -529,19 +538,17 @@ type CheckoutSessionCreateRequest = {
529
538
  /**
530
539
  * Customer Id
531
540
  *
532
- * 顧客ID
541
+ * 顧客 ID
533
542
  */
534
543
  customer_id?: string;
535
544
  /**
536
545
  * Customer Email
537
546
  *
538
- * 顧客オブジェクトを作成する時に使われます。指定されていない場合、顧客にメールアドレスの入力を求めます。すでに顧客のメールアドレスを持っている場合は、このパラメータを使ってあらかじめ情報を入力しておくことが可能です。支払いが完了した後に顧客情報を取得したい場合は、customer属性を使用します。
547
+ * 顧客オブジェクトを作成する時に使われます。指定されていない場合、顧客にメールアドレスの入力を求めます。すでに顧客のメールアドレスを持っている場合は、このパラメータを使ってあらかじめ情報を入力しておくことが可能です。
539
548
  */
540
549
  customer_email?: string;
541
550
  /**
542
551
  * Checkout Session の確定時に Customer を作成するかどうかを指定します。<br>
543
- * Customer が作成されない場合でも `customer_details` で Checkout に入力されたメールアドレス、住所、その他の顧客データを取得できます。<br>
544
- * Customer を作成しない Session は、ダッシュボードでゲスト顧客としてグループ化されます。<br>
545
552
  * `payment` および `setup` モードでのみ設定可能です。
546
553
  */
547
554
  customer_creation?: CustomerCreation;
@@ -551,24 +558,12 @@ type CheckoutSessionCreateRequest = {
551
558
  * 顧客が購入する商品のリストです。このパラメーターを使用して、1回限りまたは定期的な料金を渡します。
552
559
  *
553
560
  * `payment` モードの場合、最大100個のラインアイテムを使用できます。
554
- * <!-- `subscription` モードの場合、定期的な料金のラインアイテムは最大20個、1回限りの料金のラインアイテムは最大20個です。1回限りの料金のラインアイテムは、最初の請求書にのみ記載されます。 -->
555
- *
556
561
  */
557
562
  line_items?: Array<LineItemRequest>;
558
- /**
559
- * Checkout Session のモード
560
- *
561
- * | 指定できる値 |
562
- * |:---|
563
- * | **payment**: 支払いモードでCheckout Sessionを作成します。 |
564
- * | **setup**: セットアップモードでCheckout Sessionを作成します。 |
565
- *
566
- */
567
- mode: CheckoutSessionMode;
568
563
  /**
569
564
  * Metadata
570
565
  *
571
- * キーバリューの任意のデータを格納できます。<a href="https://docs.pay.jp/v2/metadata">詳細はメタデータのドキュメントを参照してください。</a>
566
+ * キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href="https://docs.pay.jp/v2/guide/developers/metadata">詳細はメタデータのドキュメントを参照してください。</a>
572
567
  */
573
568
  metadata?: {
574
569
  [key: string]: string | number | boolean;
@@ -576,13 +571,13 @@ type CheckoutSessionCreateRequest = {
576
571
  /**
577
572
  * Success Url
578
573
  *
579
- * 支払いや設定が完了した際に、PAY.JP が顧客をリダイレクトするURL。成功したCheckout Sessionからの情報をページで使用したい場合は、成功ページのカスタマイズに関するガイドをお読みください。
574
+ * 支払いや設定が完了した際に、PAY.JP が顧客をリダイレクトする URL。成功した Checkout Session からの情報をページで使用したい場合は、成功ページのカスタマイズに関するガイドをお読みください。
580
575
  */
581
576
  success_url?: string;
582
577
  /**
583
578
  * Cancel Url
584
579
  *
585
- * キャンセル時のリダイレクトURL
580
+ * キャンセル時のリダイレクト URL
586
581
  */
587
582
  cancel_url?: string;
588
583
  /**
@@ -592,7 +587,7 @@ type CheckoutSessionCreateRequest = {
592
587
  /**
593
588
  * Expires At
594
589
  *
595
- * Checkout Session の有効期限が失効する日時。
590
+ * Checkout Session の有効期限が失効する日時
596
591
  */
597
592
  expires_at?: string;
598
593
  /**
@@ -601,27 +596,22 @@ type CheckoutSessionCreateRequest = {
601
596
  * | 指定できる値 |
602
597
  * |:---|
603
598
  * | **ja**: 日本語で表示します。 |
604
- *
605
599
  */
606
600
  locale?: Locale;
607
- /**
608
- * `payment` モード指定時に PaymentFlow 作成に使用するパラメーター。
609
- */
610
- payment_flow_data?: PaymentFlowDataRequest;
611
- /**
612
- * この PaymentFlow の支払い方法の個別設定。
613
- */
614
- payment_method_options?: CheckoutSessionPaymentMethodOptionsRequest;
615
601
  /**
616
602
  * Payment Method Types
617
603
  *
618
- * この PaymentFlow で使用できる支払い方法の種類（カードなど）のリストです。 指定しない場合、ダッシュボードで利用可能な状態にしている支払い方法を自動的に表示します。
604
+ * この PaymentFlow で使用できる支払い方法の種類（カードなど）のリストです。指定しない場合、管理画面で利用可能な状態にしている支払い方法を自動的に表示します。
619
605
  */
620
606
  payment_method_types?: Array<PaymentMethodTypes>;
621
607
  /**
622
- * `setup` モードの Checkout Session を作成する際、SetupFlow の作成に渡されるパラメーター
608
+ * この PaymentFlow の支払い方法の個別設定
623
609
  */
624
- setup_flow_data?: SetupFlowDataRequest;
610
+ payment_method_options?: CheckoutSessionPaymentMethodOptionsRequest;
611
+ /**
612
+ * `payment` モード指定時に PaymentFlow 作成に使用するパラメーター
613
+ */
614
+ payment_flow_data?: PaymentFlowDataRequest;
625
615
  /**
626
616
  * Checkout の画面上に表示される送信ボタンなど、ページ上の関連テキストをカスタマイズするために使用されます。<br>
627
617
  * `submit_type` は、`payment` モードの Checkout Session でのみ指定できます。未指定時、あるいは `auto` の場合、`pay` が使用されます。
@@ -632,33 +622,107 @@ type CheckoutSessionCreateRequest = {
632
622
  * | **pay**: 「支払う」（デフォルト） |
633
623
  * | **book**: 「予約する」 |
634
624
  * | **donate**: 「寄付する」 |
635
- *
636
625
  */
637
626
  submit_type?: CheckoutSessionSubmitType;
638
627
  /**
639
- * Checkout Session の UI モード。デフォルトは `hosted` です。<br>
628
+ * `setup` モードの Checkout Session を作成する際、SetupFlow の作成に渡されるパラメーター
629
+ */
630
+ setup_flow_data?: SetupFlowDataRequest;
631
+ /**
632
+ * Checkout Session の UI モード。デフォルトは `hosted` です。
640
633
  *
641
634
  * | 指定できる値 |
642
635
  * |:---|
643
- * | **hosted**: PAY.JPでホスティングしている画面を使用します。 |
644
- *
636
+ * | **hosted**: PAY.JP でホスティングしている画面を使用します。 |
645
637
  */
646
638
  ui_mode?: CheckoutSessionUiMode;
647
639
  };
648
640
  /**
649
- * CheckoutSessionDetailsResponse
641
+ * CheckoutSessionCustomerDetailsAddressResponse
642
+ *
643
+ * customer_details.address のレスポンスモデル
650
644
  */
651
- type CheckoutSessionDetailsResponse = {
645
+ type CheckoutSessionCustomerDetailsAddressResponse = {
652
646
  /**
653
- * Id
647
+ * Country
654
648
  *
655
- * ID
649
+ * 国コード
656
650
  */
657
- id: string;
651
+ country: string | null;
652
+ /**
653
+ * Zip
654
+ *
655
+ * 郵便番号
656
+ */
657
+ zip: string | null;
658
+ /**
659
+ * State
660
+ *
661
+ * 都道府県
662
+ */
663
+ state: string | null;
664
+ /**
665
+ * City
666
+ *
667
+ * 市区町村
668
+ */
669
+ city: string | null;
670
+ /**
671
+ * Line1
672
+ *
673
+ * 住所1
674
+ */
675
+ line1: string | null;
676
+ /**
677
+ * Line2
678
+ *
679
+ * 住所2
680
+ */
681
+ line2: string | null;
682
+ };
683
+ /**
684
+ * CheckoutSessionCustomerDetailsResponse
685
+ *
686
+ * customer_details のレスポンスモデル
687
+ */
688
+ type CheckoutSessionCustomerDetailsResponse = {
689
+ /**
690
+ * Name
691
+ *
692
+ * 顧客名
693
+ */
694
+ name: string | null;
695
+ /**
696
+ * Email
697
+ *
698
+ * 顧客のメールアドレス
699
+ */
700
+ email: string | null;
701
+ /**
702
+ * Phone
703
+ *
704
+ * 電話番号
705
+ */
706
+ phone: string | null;
707
+ /**
708
+ * 住所
709
+ */
710
+ address: CheckoutSessionCustomerDetailsAddressResponse | null;
711
+ };
712
+ /**
713
+ * CheckoutSessionDetailsResponse
714
+ */
715
+ type CheckoutSessionDetailsResponse = {
658
716
  /**
659
717
  * Object
660
718
  */
661
719
  object?: 'checkout.session';
720
+ /**
721
+ * Id
722
+ *
723
+ * Checkout Session ID
724
+ */
725
+ id: string;
662
726
  /**
663
727
  * Livemode
664
728
  *
@@ -677,28 +741,26 @@ type CheckoutSessionDetailsResponse = {
677
741
  * 割引と税金が適用された後のすべての商品の合計金額
678
742
  */
679
743
  amount_total: number | null;
680
- /**
681
- * Cancel Url
682
- *
683
- * キャンセル時のリダイレクトURL
684
- */
685
- cancel_url: string | null;
686
744
  /**
687
745
  * Customer Id
688
746
  *
689
- * 顧客ID
747
+ * 顧客 ID
690
748
  */
691
749
  customer_id: string | null;
692
750
  /**
693
751
  * Customer Email
694
752
  *
695
- * 顧客オブジェクトを作成する時に使われます。指定されていない場合、顧客にメールアドレスの入力を求めます。すでに顧客のメールアドレスを持っている場合は、このパラメータを使ってあらかじめ情報を入力しておくことが可能です。支払いが完了した後に顧客情報を取得したい場合は、customer属性を使用します。
753
+ * 顧客のメールアドレス
696
754
  */
697
755
  customer_email: string | null;
756
+ /**
757
+ * 顧客の詳細情報
758
+ */
759
+ customer_details?: CheckoutSessionCustomerDetailsResponse | null;
698
760
  /**
699
761
  * Expires At
700
762
  *
701
- * Checkout Session の有効期限が失効する日時。
763
+ * Checkout Session の有効期限が失効する日時
702
764
  */
703
765
  expires_at: string | null;
704
766
  /**
@@ -706,12 +768,11 @@ type CheckoutSessionDetailsResponse = {
706
768
  */
707
769
  currency: Currency;
708
770
  /**
709
- * Checkout 画面の表示言語を指定します。
771
+ * Checkout 画面の表示言語
710
772
  *
711
- * | 指定できる値 |
773
+ * | 値 |
712
774
  * |:---|
713
775
  * | **ja**: 日本語で表示します。 |
714
- *
715
776
  */
716
777
  locale: Locale | null;
717
778
  /**
@@ -723,13 +784,13 @@ type CheckoutSessionDetailsResponse = {
723
784
  /**
724
785
  * Payment Method Types
725
786
  *
726
- * この PaymentFlow で使用できる支払い方法の種類（カードなど）のリストです。 指定しない場合、ダッシュボードで利用可能な状態にしている支払い方法を自動的に表示します。
787
+ * この PaymentFlow で使用できる支払い方法の種類（カードなど）のリスト
727
788
  */
728
789
  payment_method_types: Array<PaymentMethodTypes> | null;
729
790
  /**
730
791
  * Payment Method Options
731
792
  *
732
- * この PaymentFlow の支払い方法の個別設定。
793
+ * この PaymentFlow の支払い方法の個別設定
733
794
  */
734
795
  payment_method_options: {
735
796
  [key: string]: unknown;
@@ -741,49 +802,55 @@ type CheckoutSessionDetailsResponse = {
741
802
  */
742
803
  setup_flow_id?: string | null;
743
804
  /**
744
- * Checkout の画面上に表示される送信ボタンなど、ページ上の関連テキストをカスタマイズするために使用されます。<br>
745
- * `submit_type` は、`payment` モードの Checkout Session でのみ指定できます。未指定時、あるいは `auto` の場合、`pay` が使用されます。
805
+ * Checkout の画面上に表示される送信ボタンなど、ページ上の関連テキストをカスタマイズするために使用されます。
746
806
  *
747
- * | 指定できる値 |
807
+ * | 値 |
748
808
  * |:---|
749
809
  * | **auto**: `pay` が使用されます。 |
750
810
  * | **pay**: 「支払う」（デフォルト） |
751
811
  * | **book**: 「予約する」 |
752
812
  * | **donate**: 「寄付する」 |
753
- *
754
813
  */
755
814
  submit_type: CheckoutSessionSubmitType | null;
756
815
  /**
757
816
  * Checkout Session のモード
758
817
  *
759
- * | 指定できる値 |
818
+ * | 値 |
760
819
  * |:---|
761
- * | **payment**: 支払いモードでCheckout Sessionを作成します。 |
762
- * | **setup**: セットアップモードでCheckout Sessionを作成します。 |
763
- *
820
+ * | **payment**: 支払いモード |
821
+ * | **setup**: セットアップモード |
764
822
  */
765
823
  mode: CheckoutSessionMode;
766
824
  /**
767
- * Checkout Session の UI モード。デフォルトは `hosted` です。<br>
825
+ * Checkout Session の UI モード
768
826
  *
769
- * | 指定できる値 |
827
+ * | 値 |
770
828
  * |:---|
771
- * | **hosted**: PAY.JPでホスティングしている画面を使用します。 |
772
- *
829
+ * | **hosted**: PAY.JP でホスティングしている画面を使用します。 |
773
830
  */
774
831
  ui_mode: CheckoutSessionUiMode;
775
832
  /**
776
- * Created At
833
+ * チェックアウトセッションのステータス
834
+ */
835
+ status: CheckoutSessionStatus;
836
+ /**
837
+ * Success Url
777
838
  *
778
- * 作成日時 (UTC, ISO 8601 形式)
839
+ * 支払いや設定が完了した際にリダイレクトする URL
779
840
  */
780
- created_at: string;
841
+ success_url: string | null;
781
842
  /**
782
- * Updated At
843
+ * Cancel Url
783
844
  *
784
- * 更新日時 (UTC, ISO 8601 形式)
845
+ * キャンセル時のリダイレクト URL
785
846
  */
786
- updated_at: string;
847
+ cancel_url: string | null;
848
+ /**
849
+ * Url
850
+ *
851
+ * URL
852
+ */
853
+ url: string;
787
854
  /**
788
855
  * Metadata
789
856
  *
@@ -793,21 +860,17 @@ type CheckoutSessionDetailsResponse = {
793
860
  [key: string]: string | number | boolean;
794
861
  };
795
862
  /**
796
- * チェックアウトセッションのステータス
797
- */
798
- status: CheckoutSessionStatus;
799
- /**
800
- * Success Url
863
+ * Created At
801
864
  *
802
- * 支払いや設定が完了した際に、PAY.JP が顧客をリダイレクトするURL。成功したCheckout Sessionからの情報をページで使用したい場合は、成功ページのカスタマイズに関するガイドをお読みください。
865
+ * 作成日時 (UTC, ISO 8601 形式)
803
866
  */
804
- success_url: string | null;
867
+ created_at: string;
805
868
  /**
806
- * Url
869
+ * Updated At
807
870
  *
808
- * URL
871
+ * 更新日時 (UTC, ISO 8601 形式)
809
872
  */
810
- url: string;
873
+ updated_at: string;
811
874
  };
812
875
  /**
813
876
  * CheckoutSessionLineItemDataResponse
@@ -923,7 +986,7 @@ type CheckoutSessionPaymentMethodOptionsCardRequest = {
923
986
  /**
924
987
  * Request Extended Authorization
925
988
  *
926
- * オーソリ期間の延長要求。
989
+ * オーソリ期間の延長要求
927
990
  *
928
991
  * | 指定できる値 |
929
992
  * |:---|
@@ -934,12 +997,12 @@ type CheckoutSessionPaymentMethodOptionsCardRequest = {
934
997
  /**
935
998
  * Request Three D Secure
936
999
  *
937
- * 3Dセキュア認証の要求方法。
1000
+ * 3D セキュア認証の要求方法
938
1001
  *
939
1002
  * | 指定できる値 |
940
1003
  * |:---|
941
- * | **any**: 3Dセキュア認証を要求します。 |
942
- * | **automatic**: 必要な場合にのみ3Dセキュア認証を要求します。 |
1004
+ * | **any**: 3D セキュア認証を要求します。 |
1005
+ * | **automatic**: 必要な場合にのみ 3D セキュア認証を要求します。 |
943
1006
  */
944
1007
  request_three_d_secure?: 'any' | 'automatic';
945
1008
  };
@@ -971,7 +1034,7 @@ type CheckoutSessionUpdateRequest = {
971
1034
  /**
972
1035
  * Metadata
973
1036
  *
974
- * キーバリューの任意のデータを格納できます。<a href="https://docs.pay.jp/v2/metadata">詳細はメタデータのドキュメントを参照してください。</a>
1037
+ * キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href="https://docs.pay.jp/v2/guide/developers/metadata">詳細はメタデータのドキュメントを参照してください。</a>
975
1038
  */
976
1039
  metadata?: {
977
1040
  [key: string]: string | number | boolean;
@@ -989,6 +1052,18 @@ type Currency = 'jpy';
989
1052
  * CustomerCreateRequest
990
1053
  */
991
1054
  type CustomerCreateRequest = {
1055
+ /**
1056
+ * Id
1057
+ *
1058
+ * 顧客 ID。100桁までの一意な文字列を指定できます。使える文字は半角英数字、ハイフン(-)、アンダースコア(_)です。未指定時は `cus_` で始まる一意な文字列が自動生成されます。
1059
+ */
1060
+ id?: string;
1061
+ /**
1062
+ * Payment Method Id
1063
+ *
1064
+ * 顧客に紐づける支払い方法 ID。同時にデフォルトの支払い方法として登録されます。
1065
+ */
1066
+ payment_method_id?: string;
992
1067
  /**
993
1068
  * Email
994
1069
  *
@@ -998,29 +1073,17 @@ type CustomerCreateRequest = {
998
1073
  /**
999
1074
  * Description
1000
1075
  *
1001
- * 顧客オブジェクトに付加できる任意の文字列です。これは、ダッシュボードで顧客と一緒に表示されます。
1076
+ * 顧客オブジェクトに付加できる任意の文字列です。管理画面で顧客と一緒に表示されます。
1002
1077
  */
1003
1078
  description?: string;
1004
1079
  /**
1005
1080
  * Metadata
1006
1081
  *
1007
- * キーバリューの任意のデータを格納できます。<a href="https://docs.pay.jp/v2/metadata">詳細はメタデータのドキュメントを参照してください。</a>
1082
+ * キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href="https://docs.pay.jp/v2/guide/developers/metadata">詳細はメタデータのドキュメントを参照してください。</a>
1008
1083
  */
1009
1084
  metadata?: {
1010
1085
  [key: string]: string | number | boolean;
1011
1086
  };
1012
- /**
1013
- * Id
1014
- *
1015
- * 顧客ID。100桁までの一意な文字列を指定できます。使える文字は半角英数字、ハイフン(-)、アンダースコア(_)です。未指定時は `cus_` で始まる32桁までの一意な文字列が自動生成されます。
1016
- */
1017
- id?: string;
1018
- /**
1019
- * Payment Method Id
1020
- *
1021
- * 顧客に紐づける支払い方法ID
1022
- */
1023
- payment_method_id?: string;
1024
1087
  };
1025
1088
  /**
1026
1089
  * CustomerCreation
@@ -1055,16 +1118,16 @@ type CustomerListResponse = {
1055
1118
  * CustomerResponse
1056
1119
  */
1057
1120
  type CustomerResponse = {
1121
+ /**
1122
+ * Object
1123
+ */
1124
+ object?: 'customer';
1058
1125
  /**
1059
1126
  * Id
1060
1127
  *
1061
- * 顧客ID
1128
+ * 顧客 ID
1062
1129
  */
1063
1130
  id: string;
1064
- /**
1065
- * Object
1066
- */
1067
- object?: 'customer';
1068
1131
  /**
1069
1132
  * Livemode
1070
1133
  *
@@ -1080,13 +1143,13 @@ type CustomerResponse = {
1080
1143
  /**
1081
1144
  * Description
1082
1145
  *
1083
- * 顧客の説明
1146
+ * 顧客オブジェクトにセットされた任意の文字列
1084
1147
  */
1085
1148
  description: string | null;
1086
1149
  /**
1087
1150
  * Default Payment Method Id
1088
1151
  *
1089
- * 支払いにデフォルトで使用される支払い方法ID
1152
+ * 支払いにデフォルトで使用される支払い方法 ID
1090
1153
  */
1091
1154
  default_payment_method_id: string | null;
1092
1155
  /**
@@ -1114,6 +1177,12 @@ type CustomerResponse = {
1114
1177
  * CustomerUpdateRequest
1115
1178
  */
1116
1179
  type CustomerUpdateRequest = {
1180
+ /**
1181
+ * Default Payment Method Id
1182
+ *
1183
+ * 支払いにデフォルトで使用される支払い方法 ID
1184
+ */
1185
+ default_payment_method_id?: string | null;
1117
1186
  /**
1118
1187
  * Email
1119
1188
  *
@@ -1123,23 +1192,17 @@ type CustomerUpdateRequest = {
1123
1192
  /**
1124
1193
  * Description
1125
1194
  *
1126
- * 顧客オブジェクトに付加できる任意の文字列です。これは、ダッシュボードで顧客と一緒に表示されます。
1195
+ * 顧客オブジェクトに付加できる任意の文字列です。管理画面で顧客と一緒に表示されます。
1127
1196
  */
1128
1197
  description?: string;
1129
1198
  /**
1130
1199
  * Metadata
1131
1200
  *
1132
- * キーバリューの任意のデータを格納できます。<a href="https://docs.pay.jp/v2/metadata">詳細はメタデータのドキュメントを参照してください。</a>
1201
+ * キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href="https://docs.pay.jp/v2/guide/developers/metadata">詳細はメタデータのドキュメントを参照してください。</a>
1133
1202
  */
1134
1203
  metadata?: {
1135
1204
  [key: string]: string | number | boolean;
1136
1205
  };
1137
- /**
1138
- * Default Payment Method Id
1139
- *
1140
- * 支払いにデフォルトで使用される支払い方法ID
1141
- */
1142
- default_payment_method_id?: string | null;
1143
1206
  };
1144
1207
  /**
1145
1208
  * DisplayPreferenceRequest
@@ -1148,9 +1211,9 @@ type DisplayPreferenceRequest = {
1148
1211
  /**
1149
1212
  * Preference
1150
1213
  *
1151
- * この支払い方法がアカウントで有効になっているかどうか。
1214
+ * この支払い方法がアカウントで有効になっているかどうか
1152
1215
  *
1153
- * | 指定できる値 |
1216
+ * | 値 |
1154
1217
  * |:---|
1155
1218
  * | **on**: この決済手段を決済画面に表示する |
1156
1219
  * | **off**: この決済手段を決済画面に表示しない |
@@ -1220,28 +1283,16 @@ type EventListResponse = {
1220
1283
  * EventResponse
1221
1284
  */
1222
1285
  type EventResponse = {
1223
- /**
1224
- * Id
1225
- *
1226
- * イベントID
1227
- */
1228
- id: string;
1229
1286
  /**
1230
1287
  * Object
1231
1288
  */
1232
1289
  object?: 'event';
1233
1290
  /**
1234
- * Created At
1235
- *
1236
- * 作成日時 (UTC, ISO 8601 形式)
1237
- */
1238
- created_at: string;
1239
- /**
1240
- * Updated At
1291
+ * Id
1241
1292
  *
1242
- * 更新日時 (UTC, ISO 8601 形式)
1293
+ * イベント ID
1243
1294
  */
1244
- updated_at: string;
1295
+ id: string;
1245
1296
  /**
1246
1297
  * Livemode
1247
1298
  *
@@ -1257,7 +1308,7 @@ type EventResponse = {
1257
1308
  /**
1258
1309
  * Pending Webhooks
1259
1310
  *
1260
- * 設定されたURLへの通知が完了していない(2xxのレスポンスが得られていない)webhookの数
1311
+ * 設定された URL への通知が完了していない (2xx のレスポンスが得られていない) webhook の数
1261
1312
  */
1262
1313
  pending_webhooks: number;
1263
1314
  /**
@@ -1268,6 +1319,18 @@ type EventResponse = {
1268
1319
  data: {
1269
1320
  [key: string]: unknown;
1270
1321
  };
1322
+ /**
1323
+ * Created At
1324
+ *
1325
+ * 作成日時 (UTC, ISO 8601 形式)
1326
+ */
1327
+ created_at: string;
1328
+ /**
1329
+ * Updated At
1330
+ *
1331
+ * 更新日時 (UTC, ISO 8601 形式)
1332
+ */
1333
+ updated_at: string;
1271
1334
  };
1272
1335
  /**
1273
1336
  * LineItemRequest
@@ -1276,7 +1339,7 @@ type LineItemRequest = {
1276
1339
  /**
1277
1340
  * Price Id
1278
1341
  *
1279
- * 料金ID
1342
+ * 料金 ID
1280
1343
  */
1281
1344
  price_id: string;
1282
1345
  /**
@@ -1288,7 +1351,7 @@ type LineItemRequest = {
1288
1351
  /**
1289
1352
  * Tax Rates
1290
1353
  *
1291
- * 税率ID
1354
+ * 税率 ID
1292
1355
  */
1293
1356
  tax_rates?: Array<string>;
1294
1357
  };
@@ -1303,7 +1366,7 @@ type Locale = 'auto' | 'ja';
1303
1366
  */
1304
1367
  type PayPayConfigRequest = {
1305
1368
  /**
1306
- * 支払い方法の表示設定。
1369
+ * 支払い方法の表示設定
1307
1370
  */
1308
1371
  display_preference?: DisplayPreferenceRequest | null;
1309
1372
  };
@@ -1315,16 +1378,20 @@ type PaymentFlowCancelRequest = {
1315
1378
  * Cancellation Reason
1316
1379
  *
1317
1380
  * この PaymentFlow のキャンセル理由
1318
- * | 指定できる値 |
1381
+ * | 値 |
1319
1382
  * |:---|
1320
1383
  * | **duplicate**: 重複した支払いである場合。 |
1321
1384
  * | **fraudulent**: 不正な利用だと考えられる場合。 |
1322
1385
  * | **requested_by_customer**: 顧客がキャンセルを要求した場合。 |
1323
- * | **abandoned**: 顧客が支払いを完了しなかった場合。 |
1386
+ * | **abondoned**: 顧客が支払いを完了しなかった場合。 |
1324
1387
  *
1325
1388
  */
1326
1389
  cancellation_reason?: 'duplicate' | 'fraudulent' | 'requested_by_customer' | 'abandoned';
1327
1390
  };
1391
+ /**
1392
+ * PaymentFlowCancellationReason
1393
+ */
1394
+ type PaymentFlowCancellationReason = 'abandoned' | 'automatic' | 'duplicate' | 'expired' | 'failed_invoice' | 'fraudulent' | 'requested_by_customer' | 'void_invoice';
1328
1395
  /**
1329
1396
  * PaymentFlowCaptureRequest
1330
1397
  */
@@ -1332,7 +1399,7 @@ type PaymentFlowCaptureRequest = {
1332
1399
  /**
1333
1400
  * Amount To Capture
1334
1401
  *
1335
- * PaymentFlowから確定させる金額は、元の金額以下で指定します。指定されていない場合は、全額（`amount_capturable`）がデフォルトになります。
1402
+ * PaymentFlow から確定させる金額は、元の金額以下で指定します。指定されていない場合は、全額（`amount_capturable`）がデフォルトになります。
1336
1403
  */
1337
1404
  amount_to_capture?: number;
1338
1405
  };
@@ -1343,23 +1410,23 @@ type PaymentFlowConfirmRequest = {
1343
1410
  /**
1344
1411
  * Payment Method Id
1345
1412
  *
1346
- * 支払い方法ID。customer_idの指定が必須です。Customerが所持するPaymentMethodのみ指定できます。payment_method_idを指定せず、Customerにdefault_payment_method_idが設定されている場合はそちらが自動でセットされます。
1413
+ * 支払い方法 ID。customer_id の指定が必須です。Customer が所持する PaymentMethod のみ指定できます。payment_method_id を指定せず、Customer に default_payment_method_id が設定されている場合はそちらが自動でセットされます。
1347
1414
  */
1348
1415
  payment_method_id?: string;
1349
1416
  /**
1350
- * このPaymentFlow固有の支払い方法の設定
1417
+ * この PaymentFlow 固有の支払い方法の設定
1351
1418
  */
1352
1419
  payment_method_options?: PaymentFlowPaymentMethodOptionsRequest;
1353
1420
  /**
1354
1421
  * Payment Method Types
1355
1422
  *
1356
- * このPaymentFlowで使用できる支払い方法の種類のリスト。 指定しない場合は、PAY.JPは支払い方法の設定から利用可能な支払い方法を動的に表示します。
1423
+ * この PaymentFlow で使用できる支払い方法の種類のリスト。指定しない場合は、PAY.JP は支払い方法の設定から利用可能な支払い方法を動的に表示します。
1357
1424
  */
1358
1425
  payment_method_types?: Array<PaymentMethodTypes>;
1359
1426
  /**
1360
1427
  * 支払いの確定方法を指定します。
1361
1428
  *
1362
- * | 指定できる値 |
1429
+ * | 値 |
1363
1430
  * |:---|
1364
1431
  * | **automatic**: (デフォルト) 顧客が支払いを承認すると、自動的に確定させます。 |
1365
1432
  * | **manual**: 顧客が支払いを承認すると一旦確定を保留し、後で Capture API を使用して確定します。（すべての支払い方法がこれをサポートしているわけではありません）。 |
@@ -1368,7 +1435,7 @@ type PaymentFlowConfirmRequest = {
1368
1435
  /**
1369
1436
  * Return Url
1370
1437
  *
1371
- * 顧客が支払いを完了後かキャンセルした後にリダイレクトされるURL。アプリにリダイレクトしたい場合は URI Scheme を指定できます。
1438
+ * 顧客が支払いを完了後かキャンセルした後にリダイレクトされる URL。アプリにリダイレクトしたい場合は URI Scheme を指定できます。
1372
1439
  */
1373
1440
  return_url?: string;
1374
1441
  /**
@@ -1391,23 +1458,23 @@ type PaymentFlowCreateRequest = {
1391
1458
  /**
1392
1459
  * Customer Id
1393
1460
  *
1394
- * このPaymentFlowに関連付ける顧客のID
1461
+ * この PaymentFlow に関連付ける顧客の ID
1395
1462
  */
1396
1463
  customer_id?: string;
1397
1464
  /**
1398
1465
  * Payment Method Id
1399
1466
  *
1400
- * 支払い方法ID。customer_idの指定が必須です。Customerが所持するPaymentMethodのみ指定できます。payment_method_idを指定せず、Customerにdefault_payment_method_idが設定されている場合はそちらが自動でセットされます。
1467
+ * 支払い方法 ID。customer_id の指定が必須です。Customer が所持する PaymentMethod のみ指定できます。payment_method_id を指定せず、Customer に default_payment_method_id が設定されている場合はそちらが自動でセットされます。
1401
1468
  */
1402
1469
  payment_method_id?: string;
1403
1470
  /**
1404
- * このPaymentFlow固有の支払い方法の設定
1471
+ * この PaymentFlow 固有の支払い方法の設定
1405
1472
  */
1406
1473
  payment_method_options?: PaymentFlowPaymentMethodOptionsRequest;
1407
1474
  /**
1408
1475
  * Payment Method Types
1409
1476
  *
1410
- * このPaymentFlowで使用できる支払い方法の種類のリスト。 指定しない場合は、PAY.JPは支払い方法の設定から利用可能な支払い方法を動的に表示します。
1477
+ * この PaymentFlow で使用できる支払い方法の種類のリスト。指定しない場合は、PAY.JP は支払い方法の設定から利用可能な支払い方法を動的に表示します。
1411
1478
  */
1412
1479
  payment_method_types?: Array<PaymentMethodTypes>;
1413
1480
  /**
@@ -1417,7 +1484,7 @@ type PaymentFlowCreateRequest = {
1417
1484
  /**
1418
1485
  * 支払いの確定方法を指定します。
1419
1486
  *
1420
- * | 指定できる値 |
1487
+ * | 値 |
1421
1488
  * |:---|
1422
1489
  * | **automatic**: (デフォルト) 顧客が支払いを承認すると、自動的に確定させます。 |
1423
1490
  * | **manual**: 顧客が支払いを承認すると一旦確定を保留し、後で Capture API を使用して確定します。（すべての支払い方法がこれをサポートしているわけではありません）。 |
@@ -1426,13 +1493,13 @@ type PaymentFlowCreateRequest = {
1426
1493
  /**
1427
1494
  * Confirm
1428
1495
  *
1429
- * 「true」に設定すると、このPaymentFlowを直ちに確定しようと試みます。
1496
+ * 「true」に設定すると、この PaymentFlow を直ちに確定しようと試みます。
1430
1497
  */
1431
1498
  confirm?: boolean;
1432
1499
  /**
1433
1500
  * Return Url
1434
1501
  *
1435
- * 顧客が支払いを完了後かキャンセルした後にリダイレクトされるURL。アプリにリダイレクトしたい場合は URI Scheme を指定できます。confirm=trueの場合のみ指定できます。
1502
+ * 顧客が支払いを完了後かキャンセルした後にリダイレクトされる URL。アプリにリダイレクトしたい場合は URI Scheme を指定できます。confirm=true の場合のみ指定できます。
1436
1503
  */
1437
1504
  return_url?: string;
1438
1505
  /**
@@ -1444,7 +1511,7 @@ type PaymentFlowCreateRequest = {
1444
1511
  /**
1445
1512
  * Metadata
1446
1513
  *
1447
- * キーバリューの任意のデータを格納できます。<a href="https://docs.pay.jp/v2/metadata">詳細はメタデータのドキュメントを参照してください。</a>
1514
+ * キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href="https://docs.pay.jp/v2/guide/developers/metadata">詳細はメタデータのドキュメントを参照してください。</a>
1448
1515
  */
1449
1516
  metadata?: {
1450
1517
  [key: string]: string | number | boolean;
@@ -1459,14 +1526,14 @@ type PaymentFlowDataRequest = {
1459
1526
  *
1460
1527
  * | 指定できる値 |
1461
1528
  * |:---|
1462
- * | **automatic**: (デフォルト) 顧客が支払いを承認すると自動的に確定します。 |
1529
+ * | **automatic**: 顧客が支払いを承認すると自動的に確定します。 |
1463
1530
  * | **manual**: 顧客が支払いを承認すると一旦確定を保留し、後で Capture API を使用して確定します。（すべての支払い方法がこれをサポートしているわけではありません）。 |
1464
1531
  */
1465
1532
  capture_method?: CaptureMethod;
1466
1533
  /**
1467
1534
  * Metadata
1468
1535
  *
1469
- * キーバリューの任意のデータを格納できます。<a href="https://docs.pay.jp/v2/metadata">詳細はメタデータのドキュメントを参照してください。</a>
1536
+ * キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href="https://docs.pay.jp/v2/guide/developers/metadata">詳細はメタデータのドキュメントを参照してください。</a>
1470
1537
  */
1471
1538
  metadata?: {
1472
1539
  [key: string]: string | number | boolean;
@@ -1508,7 +1575,7 @@ type PaymentFlowPaymentMethodOptionsCardRequest = {
1508
1575
  *
1509
1576
  * オーソリ期間の延長要求
1510
1577
  *
1511
- * | 指定できる値 |
1578
+ * | 値 |
1512
1579
  * |:---|
1513
1580
  * | **if_available**: オーソリ期間の延長が可能な場合に延長要求を行います。 |
1514
1581
  * | **never**: オーソリ期間の延長要求を行いません。 |
@@ -1517,12 +1584,12 @@ type PaymentFlowPaymentMethodOptionsCardRequest = {
1517
1584
  /**
1518
1585
  * Request Three D Secure
1519
1586
  *
1520
- * 3Dセキュア認証の要求方法。
1587
+ * 3D セキュア認証の要求方法。
1521
1588
  *
1522
- * | 指定できる値 |
1589
+ * | 値 |
1523
1590
  * |:---|
1524
- * | **any**: 3Dセキュア認証を要求します。 |
1525
- * | **automatic**: 必要な場合にのみ3Dセキュア認証を要求します。 |
1591
+ * | **any**: 3D セキュア認証を要求します。 |
1592
+ * | **automatic**: 必要な場合にのみ 3D セキュア認証を要求します。 |
1526
1593
  */
1527
1594
  request_three_d_secure?: 'any' | 'automatic';
1528
1595
  };
@@ -1539,28 +1606,16 @@ type PaymentFlowPaymentMethodOptionsRequest = {
1539
1606
  * PaymentFlowResponse
1540
1607
  */
1541
1608
  type PaymentFlowResponse = {
1542
- /**
1543
- * Id
1544
- *
1545
- * 支払いフローID
1546
- */
1547
- id: string;
1548
1609
  /**
1549
1610
  * Object
1550
1611
  */
1551
1612
  object?: 'payment_flow';
1552
1613
  /**
1553
- * Created At
1554
- *
1555
- * 作成日時 (UTC, ISO 8601 形式)
1556
- */
1557
- created_at: string;
1558
- /**
1559
- * Updated At
1614
+ * Id
1560
1615
  *
1561
- * 更新日時 (UTC, ISO 8601 形式)
1616
+ * 支払いフロー ID
1562
1617
  */
1563
- updated_at: string;
1618
+ id: string;
1564
1619
  /**
1565
1620
  * Livemode
1566
1621
  *
@@ -1580,25 +1635,25 @@ type PaymentFlowResponse = {
1580
1635
  /**
1581
1636
  * Amount Capturable
1582
1637
  *
1583
- * このPaymentFlowの確定可能な金額
1638
+ * この PaymentFlow の確定可能な金額
1584
1639
  */
1585
1640
  amount_capturable: number | null;
1586
1641
  /**
1587
1642
  * Amount Received
1588
1643
  *
1589
- * このPaymentFlowの `amount` のうち、確定した金額
1644
+ * この PaymentFlow の `amount` のうち、確定した金額
1590
1645
  */
1591
1646
  amount_received: number | null;
1592
1647
  /**
1593
1648
  * Client Secret
1594
1649
  *
1595
- * このPaymentFlowのクライアントシークレットです。フロントエンドで公開APIキーと合わせて使用しPaymentFlowの情報を取得や支払い処理を行います。**この値はこのPaymentFlowの支払いを行う顧客以外へ公開しないでください。**また保存やログへの記録なども行わないでください。
1650
+ * この PaymentFlow のクライアントシークレットです。フロントエンドで公開 API キーと合わせて使用し PaymentFlow の情報を取得や支払い処理を行います。**この値はこの PaymentFlow の支払いを行う顧客以外へ公開しないでください。**また保存やログへの記録なども行わないでください。
1596
1651
  */
1597
1652
  client_secret: string;
1598
1653
  /**
1599
1654
  * Customer Id
1600
1655
  *
1601
- * このPaymentFlowに関連付けられた顧客のID
1656
+ * この PaymentFlow に関連付けられた顧客の ID
1602
1657
  */
1603
1658
  customer_id: string | null;
1604
1659
  /**
@@ -1607,24 +1662,16 @@ type PaymentFlowResponse = {
1607
1662
  * オブジェクトにセットする任意の文字列。ユーザーには表示されません。
1608
1663
  */
1609
1664
  description: string | null;
1610
- /**
1611
- * Metadata
1612
- *
1613
- * メタデータ
1614
- */
1615
- metadata: {
1616
- [key: string]: string | number | boolean;
1617
- };
1618
1665
  /**
1619
1666
  * Payment Method Id
1620
1667
  *
1621
- * 支払い方法ID
1668
+ * 支払い方法 ID
1622
1669
  */
1623
1670
  payment_method_id: string | null;
1624
1671
  /**
1625
1672
  * Payment Method Options
1626
1673
  *
1627
- * このPaymentFlow固有の支払い方法の設定
1674
+ * この PaymentFlow 固有の支払い方法の設定
1628
1675
  */
1629
1676
  payment_method_options: {
1630
1677
  [key: string]: unknown;
@@ -1632,11 +1679,11 @@ type PaymentFlowResponse = {
1632
1679
  /**
1633
1680
  * Payment Method Types
1634
1681
  *
1635
- * このPaymentFlowで使用できる支払い方法の種類のリスト
1682
+ * この PaymentFlow で使用できる支払い方法の種類のリスト
1636
1683
  */
1637
1684
  payment_method_types: Array<PaymentMethodTypes>;
1638
1685
  /**
1639
- * このPaymentFlowのステータス。<a href="https://docs.pay.jp/v2/payment_flows#status" target="_blank">ステータスの詳細についてはこちらをご覧ください。</a>
1686
+ * この PaymentFlow のステータス。<a href="https://docs.pay.jp/v2/payment_flows#status" target="_blank">ステータスの詳細についてはこちらをご覧ください。</a>
1640
1687
  *
1641
1688
  * | 値 |
1642
1689
  * |:---|
@@ -1660,26 +1707,67 @@ type PaymentFlowResponse = {
1660
1707
  /**
1661
1708
  * Return Url
1662
1709
  *
1663
- * 顧客が支払いを完了後かキャンセルした後にリダイレクトされるURL
1710
+ * 顧客が支払いを完了後かキャンセルした後にリダイレクトされる URL
1664
1711
  */
1665
1712
  return_url: string | null;
1666
1713
  /**
1667
- * 支払いの確定方法
1714
+ * 支払いの確定方法
1715
+ *
1716
+ * | 値 |
1717
+ * |:---|
1718
+ * | **automatic**: (デフォルト) 顧客が支払いを承認すると、自動的に確定させます。 |
1719
+ * | **manual**: 顧客が支払いを承認すると一旦確定を保留し、後で Capture API を使用して確定します。（すべての支払い方法がこれをサポートしているわけではありません）。 |
1720
+ */
1721
+ capture_method: CaptureMethod;
1722
+ /**
1723
+ * Last Payment Error
1724
+ *
1725
+ * この PaymentFlow で発生した最後の支払いエラー
1726
+ */
1727
+ last_payment_error: {
1728
+ [key: string]: unknown;
1729
+ } | null;
1730
+ /**
1731
+ * この PaymentFlow がキャンセルされた理由
1732
+ *
1733
+ * | 値 |
1734
+ * |:---|
1735
+ * | **abandoned**: 放棄、中断 |
1736
+ * | **automatic**: 自動 |
1737
+ * | **duplicate**: 重複 |
1738
+ * | **expired**: 期限切れ |
1739
+ * | **failed_invoice**: 請求書の失敗 |
1740
+ * | **fraudulent**: 不正利用 |
1741
+ * | **requested_by_customer**: 顧客からの要請 |
1742
+ * | **void_invoice**: 請求書の無効化 |
1743
+ */
1744
+ cancellation_reason: PaymentFlowCancellationReason | null;
1745
+ /**
1746
+ * Canceled At
1747
+ *
1748
+ * キャンセル日時 (UTC, ISO 8601 形式)
1749
+ */
1750
+ canceled_at: string | null;
1751
+ /**
1752
+ * Metadata
1753
+ *
1754
+ * メタデータ
1755
+ */
1756
+ metadata: {
1757
+ [key: string]: string | number | boolean;
1758
+ };
1759
+ /**
1760
+ * Created At
1668
1761
  *
1669
- * | 指定できる値 |
1670
- * |:---|
1671
- * | **automatic**: (デフォルト) 顧客が支払いを承認すると、自動的に確定させます。 |
1672
- * | **manual**: 顧客が支払いを承認すると一旦確定を保留し、後で Capture API を使用して確定します。（すべての支払い方法がこれをサポートしているわけではありません）。 |
1762
+ * 作成日時 (UTC, ISO 8601 形式)
1673
1763
  */
1674
- capture_method: CaptureMethod;
1764
+ created_at: string;
1675
1765
  /**
1676
- * Last Payment Error
1766
+ * Updated At
1677
1767
  *
1678
- * このPaymentFlowで発生した最後の支払いエラー
1768
+ * 更新日時 (UTC, ISO 8601 形式)
1679
1769
  */
1680
- last_payment_error: {
1681
- [key: string]: unknown;
1682
- } | null;
1770
+ updated_at: string;
1683
1771
  };
1684
1772
  /**
1685
1773
  * PaymentFlowStatus
@@ -1698,29 +1786,29 @@ type PaymentFlowUpdateRequest = {
1698
1786
  /**
1699
1787
  * Customer Id
1700
1788
  *
1701
- * このPaymentFlowに関連付ける顧客のID
1789
+ * この PaymentFlow に関連付ける顧客の ID
1702
1790
  */
1703
1791
  customer_id?: string;
1704
1792
  /**
1705
1793
  * Payment Method Id
1706
1794
  *
1707
- * 支払い方法ID。customer_idの指定が必須です。Customerが所持するPaymentMethodのみ指定できます。payment_method_idを指定せず、Customerにdefault_payment_method_idが設定されている場合はそちらが自動でセットされます。
1795
+ * 支払い方法 ID。customer_id の指定が必須です。Customer が所持する PaymentMethod のみ指定できます。payment_method_id を指定せず、Customer に default_payment_method_id が設定されている場合はそちらが自動でセットされます。
1708
1796
  */
1709
1797
  payment_method_id?: string;
1710
1798
  /**
1711
- * このPaymentFlow固有の支払い方法の設定
1799
+ * この PaymentFlow 固有の支払い方法の設定
1712
1800
  */
1713
1801
  payment_method_options?: PaymentFlowPaymentMethodOptionsRequest;
1714
1802
  /**
1715
1803
  * Payment Method Types
1716
1804
  *
1717
- * このPaymentFlowで使用できる支払い方法の種類のリスト。 指定しない場合は、PAY.JPは支払い方法の設定から利用可能な支払い方法を動的に表示します。
1805
+ * この PaymentFlow で使用できる支払い方法の種類のリスト。指定しない場合は、PAY.JP は支払い方法の設定から利用可能な支払い方法を動的に表示します。
1718
1806
  */
1719
1807
  payment_method_types?: Array<PaymentMethodTypes>;
1720
1808
  /**
1721
1809
  * Return Url
1722
1810
  *
1723
- * 顧客が支払いを完了後かキャンセルした後にリダイレクトされるURL。アプリにリダイレクトしたい場合は URI Scheme を指定できます。
1811
+ * 顧客が支払いを完了後かキャンセルした後にリダイレクトされる URL。アプリにリダイレクトしたい場合は URI Scheme を指定できます。
1724
1812
  */
1725
1813
  return_url?: string;
1726
1814
  /**
@@ -1732,7 +1820,7 @@ type PaymentFlowUpdateRequest = {
1732
1820
  /**
1733
1821
  * Metadata
1734
1822
  *
1735
- * キーバリューの任意のデータを格納できます。<a href="https://docs.pay.jp/v2/metadata">詳細はメタデータのドキュメントを参照してください。</a>
1823
+ * キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href="https://docs.pay.jp/v2/guide/developers/metadata">詳細はメタデータのドキュメントを参照してください。</a>
1736
1824
  */
1737
1825
  metadata?: {
1738
1826
  [key: string]: string | number | boolean;
@@ -1745,7 +1833,7 @@ type PaymentMethodApplePayCreateRequest = {
1745
1833
  /**
1746
1834
  * Customer Id
1747
1835
  *
1748
- * 顧客ID
1836
+ * 顧客 ID
1749
1837
  */
1750
1838
  customer_id?: string;
1751
1839
  /**
@@ -1755,7 +1843,7 @@ type PaymentMethodApplePayCreateRequest = {
1755
1843
  /**
1756
1844
  * Metadata
1757
1845
  *
1758
- * キーバリューの任意のデータを格納できます。<a href="https://docs.pay.jp/v2/metadata">詳細はメタデータのドキュメントを参照してください。</a>
1846
+ * キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href="https://docs.pay.jp/v2/guide/developers/metadata">詳細はメタデータのドキュメントを参照してください。</a>
1759
1847
  */
1760
1848
  metadata?: {
1761
1849
  [key: string]: string | number | boolean;
@@ -1763,13 +1851,13 @@ type PaymentMethodApplePayCreateRequest = {
1763
1851
  /**
1764
1852
  * Type
1765
1853
  *
1766
- * Apple Pay決済の場合は `apple_pay` を指定します。
1854
+ * Apple Pay 決済の場合は `apple_pay` を指定します。
1767
1855
  */
1768
1856
  type: 'apple_pay';
1769
1857
  /**
1770
1858
  * Token
1771
1859
  *
1772
- * Apple Payのトークン
1860
+ * Apple Pay のトークン
1773
1861
  */
1774
1862
  token: string;
1775
1863
  };
@@ -1784,7 +1872,7 @@ type PaymentMethodApplePayUpdateRequest = {
1784
1872
  /**
1785
1873
  * Metadata
1786
1874
  *
1787
- * キーバリューの任意のデータを格納できます。<a href="https://docs.pay.jp/v2/metadata">詳細はメタデータのドキュメントを参照してください。</a>
1875
+ * キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href="https://docs.pay.jp/v2/guide/developers/metadata">詳細はメタデータのドキュメントを参照してください。</a>
1788
1876
  */
1789
1877
  metadata?: {
1790
1878
  [key: string]: string | number | boolean;
@@ -1792,7 +1880,7 @@ type PaymentMethodApplePayUpdateRequest = {
1792
1880
  /**
1793
1881
  * Type
1794
1882
  *
1795
- * Apple Pay決済の場合は `apple_pay` を指定します。
1883
+ * Apple Pay 決済の場合は `apple_pay` を指定します。
1796
1884
  */
1797
1885
  type: 'apple_pay';
1798
1886
  };
@@ -1803,7 +1891,7 @@ type PaymentMethodAttachRequest = {
1803
1891
  /**
1804
1892
  * Customer Id
1805
1893
  *
1806
- * 顧客ID
1894
+ * 顧客 ID
1807
1895
  */
1808
1896
  customer_id: string;
1809
1897
  };
@@ -1929,13 +2017,13 @@ type PaymentMethodBillingDetailsResponse = {
1929
2017
  /**
1930
2018
  * Phone
1931
2019
  *
1932
- * 請求先の電話番号（ `type=card` の場合、 `phone` または `email` のどちらかは必須）
2020
+ * 請求先の電話番号
1933
2021
  */
1934
2022
  phone: string | null;
1935
2023
  /**
1936
2024
  * Email
1937
2025
  *
1938
- * 請求先のメールアドレス（ `type=card` の場合、 `phone` または `email` のどちらかは必須）
2026
+ * 請求先のメールアドレス
1939
2027
  */
1940
2028
  email: string | null;
1941
2029
  /**
@@ -1979,7 +2067,7 @@ type PaymentMethodCardCreateRequest = {
1979
2067
  /**
1980
2068
  * Customer Id
1981
2069
  *
1982
- * 顧客ID
2070
+ * 顧客 ID
1983
2071
  */
1984
2072
  customer_id?: string;
1985
2073
  /**
@@ -1989,7 +2077,7 @@ type PaymentMethodCardCreateRequest = {
1989
2077
  /**
1990
2078
  * Metadata
1991
2079
  *
1992
- * キーバリューの任意のデータを格納できます。<a href="https://docs.pay.jp/v2/metadata">詳細はメタデータのドキュメントを参照してください。</a>
2080
+ * キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href="https://docs.pay.jp/v2/guide/developers/metadata">詳細はメタデータのドキュメントを参照してください。</a>
1993
2081
  */
1994
2082
  metadata?: {
1995
2083
  [key: string]: string | number | boolean;
@@ -2036,7 +2124,7 @@ type PaymentMethodCardDetailsResponse = {
2036
2124
  /**
2037
2125
  * Fingerprint
2038
2126
  *
2039
- * fingerprint
2127
+ * このクレジットカード番号に紐づく値。同一番号のカードからは同一の値が生成されることが保証されています。
2040
2128
  */
2041
2129
  fingerprint: string;
2042
2130
  /**
@@ -2060,6 +2148,12 @@ type PaymentMethodCardResponse = {
2060
2148
  * ID
2061
2149
  */
2062
2150
  id: string;
2151
+ /**
2152
+ * Livemode
2153
+ *
2154
+ * 本番環境かどうか
2155
+ */
2156
+ livemode: boolean;
2063
2157
  /**
2064
2158
  * Type
2065
2159
  */
@@ -2067,21 +2161,23 @@ type PaymentMethodCardResponse = {
2067
2161
  /**
2068
2162
  * Customer Id
2069
2163
  *
2070
- * 顧客ID
2164
+ * 顧客 ID
2071
2165
  */
2072
2166
  customer_id: string | null;
2073
2167
  /**
2074
2168
  * Detached At
2075
2169
  *
2076
- * 顧客からdetachされた日時 (UTC, ISO 8601 形式)
2170
+ * 顧客から detach された日時 (UTC, ISO 8601 形式)
2077
2171
  */
2078
2172
  detached_at: string | null;
2079
2173
  /**
2080
- * Livemode
2174
+ * Metadata
2081
2175
  *
2082
- * 本番環境かどうか
2176
+ * メタデータ
2083
2177
  */
2084
- livemode: boolean;
2178
+ metadata: {
2179
+ [key: string]: string | number | boolean;
2180
+ };
2085
2181
  /**
2086
2182
  * Created At
2087
2183
  *
@@ -2094,14 +2190,6 @@ type PaymentMethodCardResponse = {
2094
2190
  * 更新日時 (UTC, ISO 8601 形式)
2095
2191
  */
2096
2192
  updated_at: string;
2097
- /**
2098
- * Metadata
2099
- *
2100
- * メタデータ
2101
- */
2102
- metadata: {
2103
- [key: string]: string | number | boolean;
2104
- };
2105
2193
  /**
2106
2194
  * 請求先情報
2107
2195
  */
@@ -2122,7 +2210,7 @@ type PaymentMethodCardUpdateRequest = {
2122
2210
  /**
2123
2211
  * Metadata
2124
2212
  *
2125
- * キーバリューの任意のデータを格納できます。<a href="https://docs.pay.jp/v2/metadata">詳細はメタデータのドキュメントを参照してください。</a>
2213
+ * キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href="https://docs.pay.jp/v2/guide/developers/metadata">詳細はメタデータのドキュメントを参照してください。</a>
2126
2214
  */
2127
2215
  metadata?: {
2128
2216
  [key: string]: string | number | boolean;
@@ -2138,28 +2226,28 @@ type PaymentMethodCardUpdateRequest = {
2138
2226
  * PaymentMethodConfigurationDetailsResponse
2139
2227
  */
2140
2228
  type PaymentMethodConfigurationDetailsResponse = {
2141
- /**
2142
- * Id
2143
- *
2144
- * ID
2145
- */
2146
- id: string;
2147
2229
  /**
2148
2230
  * Object
2149
2231
  */
2150
2232
  object?: 'payment_method_configuration';
2151
2233
  /**
2152
- * Active
2234
+ * Id
2153
2235
  *
2154
- * 設定が有効かどうか。
2236
+ * 支払い方法設定 ID
2155
2237
  */
2156
- active: boolean;
2238
+ id: string;
2157
2239
  /**
2158
2240
  * Livemode
2159
2241
  *
2160
2242
  * 本番環境かどうか
2161
2243
  */
2162
2244
  livemode: boolean;
2245
+ /**
2246
+ * Active
2247
+ *
2248
+ * 設定が有効かどうか
2249
+ */
2250
+ active: boolean;
2163
2251
  /**
2164
2252
  * Name
2165
2253
  *
@@ -2167,7 +2255,7 @@ type PaymentMethodConfigurationDetailsResponse = {
2167
2255
  */
2168
2256
  name: string | null;
2169
2257
  /**
2170
- * PayPayの設定
2258
+ * PayPay の設定
2171
2259
  */
2172
2260
  paypay: PaymentMethodConfigurationSettingResponse;
2173
2261
  /**
@@ -2182,9 +2270,9 @@ type PaymentMethodConfigurationDisplayPreference = {
2182
2270
  /**
2183
2271
  * Preference
2184
2272
  *
2185
- * この支払い方法がアカウントで有効になっているかどうか。
2273
+ * この支払い方法がアカウントで有効になっているかどうか
2186
2274
  *
2187
- * | 指定できる値 |
2275
+ * | 値 |
2188
2276
  * |:---|
2189
2277
  * | **on**: この決済手段を決済画面に表示する |
2190
2278
  * | **off**: この決済手段を決済画面に表示しない |
@@ -2196,7 +2284,7 @@ type PaymentMethodConfigurationDisplayPreference = {
2196
2284
  *
2197
2285
  * この支払い方法を決済画面に表示するかどうか。
2198
2286
  *
2199
- * | 指定できる値 |
2287
+ * | 値 |
2200
2288
  * |:---|
2201
2289
  * | **on**: この決済手段を決済画面に表示する |
2202
2290
  * | **off**: この決済手段を決済画面に表示しない |
@@ -2239,7 +2327,7 @@ type PaymentMethodConfigurationSettingResponse = {
2239
2327
  */
2240
2328
  available?: boolean;
2241
2329
  /**
2242
- * 支払い方法の表示設定。
2330
+ * 支払い方法の表示設定
2243
2331
  */
2244
2332
  display_preference?: PaymentMethodConfigurationDisplayPreference;
2245
2333
  };
@@ -2250,7 +2338,7 @@ type PaymentMethodConfigurationUpdateRequest = {
2250
2338
  /**
2251
2339
  * Active
2252
2340
  *
2253
- * 設定が有効かどうか。
2341
+ * 設定が有効かどうか
2254
2342
  */
2255
2343
  active?: boolean | null;
2256
2344
  /**
@@ -2333,7 +2421,7 @@ type PaymentMethodPayPayCreateRequest = {
2333
2421
  /**
2334
2422
  * Customer Id
2335
2423
  *
2336
- * 顧客ID
2424
+ * 顧客 ID
2337
2425
  */
2338
2426
  customer_id?: string;
2339
2427
  /**
@@ -2343,7 +2431,7 @@ type PaymentMethodPayPayCreateRequest = {
2343
2431
  /**
2344
2432
  * Metadata
2345
2433
  *
2346
- * キーバリューの任意のデータを格納できます。<a href="https://docs.pay.jp/v2/metadata">詳細はメタデータのドキュメントを参照してください。</a>
2434
+ * キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href="https://docs.pay.jp/v2/guide/developers/metadata">詳細はメタデータのドキュメントを参照してください。</a>
2347
2435
  */
2348
2436
  metadata?: {
2349
2437
  [key: string]: string | number | boolean;
@@ -2351,7 +2439,7 @@ type PaymentMethodPayPayCreateRequest = {
2351
2439
  /**
2352
2440
  * Type
2353
2441
  *
2354
- * PayPay決済の場合は `paypay` を指定します。
2442
+ * PayPay 決済の場合は `paypay` を指定します。
2355
2443
  */
2356
2444
  type: 'paypay';
2357
2445
  };
@@ -2369,6 +2457,12 @@ type PaymentMethodPayPayResponse = {
2369
2457
  * ID
2370
2458
  */
2371
2459
  id: string;
2460
+ /**
2461
+ * Livemode
2462
+ *
2463
+ * 本番環境かどうか
2464
+ */
2465
+ livemode: boolean;
2372
2466
  /**
2373
2467
  * Type
2374
2468
  */
@@ -2376,21 +2470,23 @@ type PaymentMethodPayPayResponse = {
2376
2470
  /**
2377
2471
  * Customer Id
2378
2472
  *
2379
- * 顧客ID
2473
+ * 顧客 ID
2380
2474
  */
2381
2475
  customer_id: string | null;
2382
2476
  /**
2383
2477
  * Detached At
2384
2478
  *
2385
- * 顧客からdetachされた日時 (UTC, ISO 8601 形式)
2479
+ * 顧客から detach された日時 (UTC, ISO 8601 形式)
2386
2480
  */
2387
2481
  detached_at: string | null;
2388
2482
  /**
2389
- * Livemode
2483
+ * Metadata
2390
2484
  *
2391
- * 本番環境かどうか
2485
+ * メタデータ
2392
2486
  */
2393
- livemode: boolean;
2487
+ metadata: {
2488
+ [key: string]: string | number | boolean;
2489
+ };
2394
2490
  /**
2395
2491
  * Created At
2396
2492
  *
@@ -2403,14 +2499,6 @@ type PaymentMethodPayPayResponse = {
2403
2499
  * 更新日時 (UTC, ISO 8601 形式)
2404
2500
  */
2405
2501
  updated_at: string;
2406
- /**
2407
- * Metadata
2408
- *
2409
- * メタデータ
2410
- */
2411
- metadata: {
2412
- [key: string]: string | number | boolean;
2413
- };
2414
2502
  /**
2415
2503
  * 請求先情報
2416
2504
  */
@@ -2427,7 +2515,7 @@ type PaymentMethodPayPayUpdateRequest = {
2427
2515
  /**
2428
2516
  * Metadata
2429
2517
  *
2430
- * キーバリューの任意のデータを格納できます。<a href="https://docs.pay.jp/v2/metadata">詳細はメタデータのドキュメントを参照してください。</a>
2518
+ * キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href="https://docs.pay.jp/v2/guide/developers/metadata">詳細はメタデータのドキュメントを参照してください。</a>
2431
2519
  */
2432
2520
  metadata?: {
2433
2521
  [key: string]: string | number | boolean;
@@ -2435,7 +2523,7 @@ type PaymentMethodPayPayUpdateRequest = {
2435
2523
  /**
2436
2524
  * Type
2437
2525
  *
2438
- * PayPay決済の場合は `paypay` を指定します。
2526
+ * PayPay 決済の場合は `paypay` を指定します。
2439
2527
  */
2440
2528
  type: 'paypay';
2441
2529
  };
@@ -2470,27 +2558,27 @@ type PaymentRefundCreateRequest = {
2470
2558
  /**
2471
2559
  * Amount
2472
2560
  *
2473
- * 返金金額
2561
+ * 返金金額。省略すると全額返金となります。
2474
2562
  */
2475
2563
  amount?: number;
2476
- /**
2477
- * Metadata
2478
- *
2479
- * キーバリューの任意のデータを格納できます。<a href="https://docs.pay.jp/v2/metadata">詳細はメタデータのドキュメントを参照してください。</a>
2480
- */
2481
- metadata?: {
2482
- [key: string]: string | number | boolean;
2483
- };
2484
2564
  /**
2485
2565
  * 返金理由
2486
2566
  *
2487
- * | 指定できる値 |
2567
+ * | 値 |
2488
2568
  * |:---|
2489
2569
  * | **duplicate**: 重複した支払い |
2490
2570
  * | **fraudulent**: 不正な支払い |
2491
2571
  * | **requested_by_customer**: 顧客の要求 |
2492
2572
  */
2493
2573
  reason?: PaymentRefundReason;
2574
+ /**
2575
+ * Metadata
2576
+ *
2577
+ * キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href="https://docs.pay.jp/v2/guide/developers/metadata">詳細はメタデータのドキュメントを参照してください。</a>
2578
+ */
2579
+ metadata?: {
2580
+ [key: string]: string | number | boolean;
2581
+ };
2494
2582
  };
2495
2583
  /**
2496
2584
  * PaymentRefundListResponse
@@ -2527,34 +2615,28 @@ type PaymentRefundReason = 'duplicate' | 'fraudulent' | 'requested_by_customer';
2527
2615
  * PaymentRefundResponse
2528
2616
  */
2529
2617
  type PaymentRefundResponse = {
2530
- /**
2531
- * Id
2532
- *
2533
- * 返金対象となる PaymentFlow の ID
2534
- */
2535
- id: string;
2536
2618
  /**
2537
2619
  * Object
2538
2620
  */
2539
2621
  object?: 'payment_refund';
2540
2622
  /**
2541
- * Created At
2542
- *
2543
- * 作成時の日時 (UTC, ISO 8601 形式)
2544
- */
2545
- created_at: string;
2546
- /**
2547
- * Updated At
2623
+ * Id
2548
2624
  *
2549
- * 更新時の日時 (UTC, ISO 8601 形式)
2625
+ * 返金 ID
2550
2626
  */
2551
- updated_at: string;
2627
+ id: string;
2552
2628
  /**
2553
2629
  * Livemode
2554
2630
  *
2555
2631
  * 本番環境かどうか
2556
2632
  */
2557
2633
  livemode: boolean;
2634
+ /**
2635
+ * Payment Flow Id
2636
+ *
2637
+ * 返金対象となる PaymentFlow の ID
2638
+ */
2639
+ payment_flow_id: string;
2558
2640
  /**
2559
2641
  * Amount
2560
2642
  *
@@ -2564,26 +2646,21 @@ type PaymentRefundResponse = {
2564
2646
  /**
2565
2647
  * 返金ステータス
2566
2648
  *
2567
- * <a href="https://docs.pay.jp/v2/payment_refunds#refund_status" target="_blank">返金ステータスの詳細についてはこちらを参照してください。</a>
2649
+ * <a href="https://docs.pay.jp/v2/guide/status-management/refund#%E8%BF%94%E9%87%91%E3%82%B9%E3%83%86%E3%83%BC%E3%82%BF%E3%82%B9%E3%81%AE%E7%9B%A3%E8%A6%96" target="_blank">返金ステータスの詳細についてはこちらを参照してください。</a>
2568
2650
  *
2569
- * | 指定できる値 |
2651
+ * | 値 |
2570
2652
  * |:---|
2571
- * | **succeeded**: 成功 |
2572
- * | **failed**: 失敗 |
2573
- * | **pending**: 保留中 |
2574
- * | **canceled**: キャンセル |
2653
+ * | **succeeded**: 返金が成功しました |
2654
+ * | **failed**: 返金が失敗しました |
2655
+ * | **pending**: 返金処理中です |
2656
+ * | **canceled**: 返金がキャンセルされました |
2657
+ * | **requires_action**: 追加のアクションが必要です |
2575
2658
  */
2576
2659
  status: PaymentRefundStatus;
2577
- /**
2578
- * Payment Flow Id
2579
- *
2580
- * 返金対象となる PaymentFlow の ID
2581
- */
2582
- payment_flow_id: string;
2583
2660
  /**
2584
2661
  * 返金理由
2585
2662
  *
2586
- * | 指定できる値 |
2663
+ * | 値 |
2587
2664
  * |:---|
2588
2665
  * | **duplicate**: 重複した支払い |
2589
2666
  * | **fraudulent**: 不正な支払い |
@@ -2598,6 +2675,18 @@ type PaymentRefundResponse = {
2598
2675
  metadata: {
2599
2676
  [key: string]: string | number | boolean;
2600
2677
  };
2678
+ /**
2679
+ * Created At
2680
+ *
2681
+ * 作成日時 (UTC, ISO 8601 形式)
2682
+ */
2683
+ created_at: string;
2684
+ /**
2685
+ * Updated At
2686
+ *
2687
+ * 更新日時 (UTC, ISO 8601 形式)
2688
+ */
2689
+ updated_at: string;
2601
2690
  };
2602
2691
  /**
2603
2692
  * PaymentRefundStatus
@@ -2610,7 +2699,7 @@ type PaymentRefundUpdateRequest = {
2610
2699
  /**
2611
2700
  * Metadata
2612
2701
  *
2613
- * キーバリューの任意のデータを格納できます。<a href="https://docs.pay.jp/v2/metadata">詳細はメタデータのドキュメントを参照してください。</a>
2702
+ * キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href="https://docs.pay.jp/v2/guide/developers/metadata">詳細はメタデータのドキュメントを参照してください。</a>
2614
2703
  */
2615
2704
  metadata?: {
2616
2705
  [key: string]: string | number | boolean;
@@ -2639,7 +2728,7 @@ type PaymentTransactionListResponse = {
2639
2728
  /**
2640
2729
  * Data
2641
2730
  *
2642
- * PaymentTransaction一覧
2731
+ * PaymentTransaction 一覧
2643
2732
  */
2644
2733
  data: Array<PaymentTransactionResponse>;
2645
2734
  };
@@ -2647,28 +2736,16 @@ type PaymentTransactionListResponse = {
2647
2736
  * PaymentTransactionResponse
2648
2737
  */
2649
2738
  type PaymentTransactionResponse = {
2650
- /**
2651
- * Id
2652
- *
2653
- * ID
2654
- */
2655
- id: string;
2656
2739
  /**
2657
2740
  * Object
2658
2741
  */
2659
2742
  object?: 'payment_transaction';
2660
2743
  /**
2661
- * Created At
2662
- *
2663
- * 作成日時 (UTC, ISO 8601 形式)
2664
- */
2665
- created_at: string;
2666
- /**
2667
- * Updated At
2744
+ * Id
2668
2745
  *
2669
- * 更新日時 (UTC, ISO 8601 形式)
2746
+ * 決済トランザクション ID
2670
2747
  */
2671
- updated_at: string;
2748
+ id: string;
2672
2749
  /**
2673
2750
  * Livemode
2674
2751
  *
@@ -2678,7 +2755,7 @@ type PaymentTransactionResponse = {
2678
2755
  /**
2679
2756
  * Resource Id
2680
2757
  *
2681
- * PaymentTransaction生成の元になったリソースのID
2758
+ * PaymentTransaction 生成の元になったリソースの ID
2682
2759
  */
2683
2760
  resource_id: string;
2684
2761
  /**
@@ -2704,7 +2781,15 @@ type PaymentTransactionResponse = {
2704
2781
  */
2705
2782
  fee: number;
2706
2783
  /**
2707
- * PaymentTransactionの種類
2784
+ * PaymentTransaction の種類
2785
+ *
2786
+ * | 値 |
2787
+ * |:---|
2788
+ * | **payment**: 支払い |
2789
+ * | **refund**: 返金 |
2790
+ * | **chargeback**: チャージバック |
2791
+ * | **chargeback_cancel**: チャージバックのキャンセル |
2792
+ *
2708
2793
  */
2709
2794
  type: PaymentTransactionType;
2710
2795
  /**
@@ -2714,9 +2799,21 @@ type PaymentTransactionResponse = {
2714
2799
  /**
2715
2800
  * Term Id
2716
2801
  *
2717
- * 期間ID
2802
+ * 集計区間 ID
2718
2803
  */
2719
2804
  term_id: string;
2805
+ /**
2806
+ * Created At
2807
+ *
2808
+ * 作成日時 (UTC, ISO 8601 形式)
2809
+ */
2810
+ created_at: string;
2811
+ /**
2812
+ * Updated At
2813
+ *
2814
+ * 更新日時 (UTC, ISO 8601 形式)
2815
+ */
2816
+ updated_at: string;
2720
2817
  };
2721
2818
  /**
2722
2819
  * PaymentTransactionType
@@ -2727,68 +2824,68 @@ type PaymentTransactionType = 'payment' | 'refund' | 'chargeback' | 'chargeback_
2727
2824
  */
2728
2825
  type PriceCreateRequest = {
2729
2826
  /**
2730
- * Nickname
2827
+ * Product Id
2731
2828
  *
2732
- * 価格の名称。PAY.JP のダッシュボードで識別するためのもので、顧客には表示されません。
2829
+ * この価格が紐付く商品の ID
2733
2830
  */
2734
- nickname?: string;
2831
+ product_id: string;
2735
2832
  /**
2736
- * Lookup Key
2833
+ * Unit Amount
2737
2834
  *
2738
- * この価格を検索するためのキー。
2835
+ * 価格の単価
2739
2836
  */
2740
- lookup_key?: string;
2837
+ unit_amount: number;
2741
2838
  /**
2742
- * Metadata
2743
- *
2744
- * キーバリューの任意のデータを格納できます。<a href="https://docs.pay.jp/v2/metadata">詳細はメタデータのドキュメントを参照してください。</a>
2839
+ * 価格の通貨。現在は `jpy` のみサポートしています。
2745
2840
  */
2746
- metadata?: {
2747
- [key: string]: string | number | boolean;
2748
- };
2841
+ currency: Currency;
2749
2842
  /**
2750
2843
  * Id
2751
2844
  *
2752
- * 料金ID
2845
+ * 料金 ID
2753
2846
  */
2754
2847
  id?: string;
2755
- /**
2756
- * 価格の通貨。現在は `jpy` のみサポートしています。
2757
- */
2758
- currency: Currency;
2759
2848
  /**
2760
2849
  * Active
2761
2850
  *
2762
- * 価格が有効かどうか。デフォルトは `true`。
2851
+ * 価格が有効かどうか
2763
2852
  */
2764
2853
  active?: boolean;
2765
2854
  /**
2766
- * Product Id
2855
+ * Nickname
2767
2856
  *
2768
- * この価格が紐付く商品のID。
2857
+ * 価格の名称。PAY.JP の管理画面で識別するためのもので、顧客には表示されません。
2769
2858
  */
2770
- product_id: string;
2859
+ nickname?: string;
2771
2860
  /**
2772
- * Unit Amount
2861
+ * Lookup Key
2773
2862
  *
2774
- * 価格の単価。0以上の整数となります。
2863
+ * この価格を検索するためのキー
2775
2864
  */
2776
- unit_amount: number;
2865
+ lookup_key?: string;
2866
+ /**
2867
+ * Metadata
2868
+ *
2869
+ * キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href="https://docs.pay.jp/v2/guide/developers/metadata">詳細はメタデータのドキュメントを参照してください。</a>
2870
+ */
2871
+ metadata?: {
2872
+ [key: string]: string | number | boolean;
2873
+ };
2777
2874
  };
2778
2875
  /**
2779
2876
  * PriceDetailsResponse
2780
2877
  */
2781
2878
  type PriceDetailsResponse = {
2879
+ /**
2880
+ * Object
2881
+ */
2882
+ object?: 'price';
2782
2883
  /**
2783
2884
  * Id
2784
2885
  *
2785
- * 料金ID
2886
+ * 料金 ID
2786
2887
  */
2787
2888
  id: string;
2788
- /**
2789
- * Object
2790
- */
2791
- object?: 'price';
2792
2889
  /**
2793
2890
  * Livemode
2794
2891
  *
@@ -2796,66 +2893,61 @@ type PriceDetailsResponse = {
2796
2893
  */
2797
2894
  livemode: boolean;
2798
2895
  /**
2799
- * Active
2896
+ * Product Id
2800
2897
  *
2801
- * 価格が有効かどうか。デフォルトは `true`。
2898
+ * この価格が紐付く商品の ID
2802
2899
  */
2803
- active: boolean;
2900
+ product_id: string;
2804
2901
  /**
2805
- * Metadata
2902
+ * Unit Amount
2806
2903
  *
2807
- * メタデータ
2904
+ * 価格の単価
2808
2905
  */
2809
- metadata: {
2810
- [key: string]: string | number | boolean;
2811
- };
2906
+ unit_amount: number;
2812
2907
  /**
2813
- * Nickname
2814
- *
2815
- * 価格の名称。PAY.JP のダッシュボードで識別するためのもので、顧客には表示されません。
2908
+ * 価格の通貨。現在は `jpy` のみサポートしています。
2816
2909
  */
2817
- nickname: string | null;
2910
+ currency: Currency;
2818
2911
  /**
2819
- * 価格が一度限りの購入か、継続的な（サブスクリプション）購入かに応じて、`one_time` または `recurring` のいずれかとなります。
2912
+ * Active
2820
2913
  *
2821
- * | 指定できる値 |
2822
- * |:---|
2823
- * | **one_time**: 1回限りの価格。 |
2824
- * | **recurring**: 継続的な価格。 |
2914
+ * 価格が有効かどうか
2825
2915
  */
2826
- type: PriceType;
2916
+ active: boolean;
2827
2917
  /**
2828
- * Lookup Key
2918
+ * Nickname
2829
2919
  *
2830
- * この価格を検索するためのキー。
2920
+ * 価格の名称。PAY.JP の管理画面で識別するためのもので、顧客には表示されません。
2831
2921
  */
2832
- lookup_key: string | null;
2922
+ nickname: string | null;
2833
2923
  /**
2834
- * 価格の通貨。現在は `jpy` のみサポートしています。
2924
+ * 一度限りの購入を表す `one_time` が入ります。
2835
2925
  */
2836
- currency: Currency;
2926
+ type: PriceType;
2837
2927
  /**
2838
- * Product Id
2928
+ * Lookup Key
2839
2929
  *
2840
- * この価格が紐付く商品のID。
2930
+ * この価格を検索するためのキー
2841
2931
  */
2842
- product_id: string;
2932
+ lookup_key: string | null;
2843
2933
  /**
2844
- * Unit Amount
2934
+ * Metadata
2845
2935
  *
2846
- * 価格の単価。0以上の整数となります。
2936
+ * メタデータ
2847
2937
  */
2848
- unit_amount: number;
2938
+ metadata: {
2939
+ [key: string]: string | number | boolean;
2940
+ };
2849
2941
  /**
2850
2942
  * Created At
2851
2943
  *
2852
- * 支払い方法作成時の日時 (UTC, ISO 8601 形式)
2944
+ * 作成日時 (UTC, ISO 8601 形式)
2853
2945
  */
2854
2946
  created_at: string;
2855
2947
  /**
2856
2948
  * Updated At
2857
2949
  *
2858
- * 支払い方法更新時の日時 (UTC, ISO 8601 形式)
2950
+ * 更新日時 (UTC, ISO 8601 形式)
2859
2951
  */
2860
2952
  updated_at: string;
2861
2953
  };
@@ -2892,149 +2984,143 @@ type PriceType = 'one_time';
2892
2984
  * PriceUpdateRequest
2893
2985
  */
2894
2986
  type PriceUpdateRequest = {
2987
+ /**
2988
+ * Active
2989
+ *
2990
+ * 価格が有効かどうか
2991
+ */
2992
+ active?: boolean;
2895
2993
  /**
2896
2994
  * Nickname
2897
2995
  *
2898
- * 価格の名称。PAY.JP のダッシュボードで識別するためのもので、顧客には表示されません。
2996
+ * 価格の名称。PAY.JP の管理画面で識別するためのもので、顧客には表示されません。
2899
2997
  */
2900
2998
  nickname?: string;
2901
2999
  /**
2902
3000
  * Lookup Key
2903
3001
  *
2904
- * この価格を検索するためのキー。
3002
+ * この価格を検索するためのキー
2905
3003
  */
2906
3004
  lookup_key?: string;
2907
3005
  /**
2908
3006
  * Metadata
2909
3007
  *
2910
- * キーバリューの任意のデータを格納できます。<a href="https://docs.pay.jp/v2/metadata">詳細はメタデータのドキュメントを参照してください。</a>
3008
+ * キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href="https://docs.pay.jp/v2/guide/developers/metadata">詳細はメタデータのドキュメントを参照してください。</a>
2911
3009
  */
2912
3010
  metadata?: {
2913
3011
  [key: string]: string | number | boolean;
2914
3012
  };
2915
- /**
2916
- * Active
2917
- *
2918
- * 価格が有効かどうか。デフォルトは `true`。
2919
- */
2920
- active?: boolean;
2921
3013
  };
2922
3014
  /**
2923
3015
  * ProductCreateRequest
2924
3016
  */
2925
3017
  type ProductCreateRequest = {
2926
3018
  /**
2927
- * Default Price Id
2928
- *
2929
- * この商品のデフォルト価格である価格オブジェクトのID。
2930
- */
2931
- default_price_id?: string;
2932
- /**
2933
- * Description
3019
+ * Name
2934
3020
  *
2935
- * Checkoutなどで顧客に表示される商品説明。
3021
+ * Checkout などで顧客に表示される商品名
2936
3022
  */
2937
- description?: string;
3023
+ name: string;
2938
3024
  /**
2939
- * Unit Label
3025
+ * Id
2940
3026
  *
2941
- * この製品の単位を表すラベル。設定すると、Checkoutや請求書などに表示されます。（例：「個」、「ライセンス」、「時間」、「回」など）
3027
+ * 商品 ID
2942
3028
  */
2943
- unit_label?: string;
3029
+ id?: string;
2944
3030
  /**
2945
- * Url
3031
+ * Active
2946
3032
  *
2947
- * この製品の公開されているウェブページのURL。
3033
+ * 商品が購入可能かどうか
2948
3034
  */
2949
- url?: string;
3035
+ active?: boolean;
2950
3036
  /**
2951
- * Id
3037
+ * Description
2952
3038
  *
2953
- * 商品ID
3039
+ * Checkout などで顧客に表示される商品説明
2954
3040
  */
2955
- id?: string;
3041
+ description?: string;
2956
3042
  /**
2957
- * Name
3043
+ * Unit Label
2958
3044
  *
2959
- * Checkoutなどで顧客に表示される商品名。
3045
+ * この製品の単位を表すラベル。設定すると、Checkout などに表示されます。（例：「個」、「ライセンス」、「時間」、「回」など）
2960
3046
  */
2961
- name: string;
3047
+ unit_label?: string;
2962
3048
  /**
2963
- * Active
3049
+ * Url
2964
3050
  *
2965
- * 商品が購入可能かどうか。デフォルトは `true`。
3051
+ * この製品の公開されているウェブページの URL
2966
3052
  */
2967
- active?: boolean;
3053
+ url?: string;
2968
3054
  };
2969
3055
  /**
2970
3056
  * ProductDeletedResponse
2971
3057
  */
2972
3058
  type ProductDeletedResponse = {
3059
+ /**
3060
+ * Object
3061
+ */
3062
+ object?: 'product';
2973
3063
  /**
2974
3064
  * Id
2975
3065
  *
2976
- * 商品ID
3066
+ * 商品 ID
2977
3067
  */
2978
3068
  id: string;
2979
- /**
2980
- * Object
2981
- */
2982
- object?: 'product';
2983
3069
  /**
2984
3070
  * Deleted
2985
3071
  *
2986
3072
  * 削除されたかどうか
2987
3073
  */
2988
- readonly deleted: boolean;
3074
+ deleted?: boolean;
2989
3075
  };
2990
3076
  /**
2991
3077
  * ProductDetailsResponse
2992
3078
  */
2993
3079
  type ProductDetailsResponse = {
3080
+ /**
3081
+ * Object
3082
+ */
3083
+ object?: 'product';
2994
3084
  /**
2995
3085
  * Id
2996
3086
  *
2997
- * 商品ID
3087
+ * 商品 ID
2998
3088
  */
2999
3089
  id: string;
3000
- /**
3001
- * Object
3002
- */
3003
- object?: 'product';
3004
3090
  /**
3005
3091
  * Name
3006
3092
  *
3007
- * Checkoutなどで顧客に表示される商品名。
3093
+ * Checkout などで顧客に表示される商品名
3008
3094
  */
3009
3095
  name: string;
3010
3096
  /**
3011
3097
  * Active
3012
3098
  *
3013
- * 商品が購入可能かどうか。デフォルトは `true`。
3099
+ * 商品が購入可能かどうか
3014
3100
  */
3015
3101
  active: boolean;
3016
3102
  /**
3017
3103
  * Default Price Id
3018
3104
  *
3019
- * この商品のデフォルト価格である価格オブジェクトのID。
3105
+ * この商品のデフォルト価格である価格オブジェクトの ID
3020
3106
  */
3021
3107
  default_price_id: string | null;
3022
3108
  /**
3023
3109
  * Description
3024
3110
  *
3025
- * Checkoutなどで顧客に表示される商品説明。
3111
+ * Checkout などで顧客に表示される商品説明
3026
3112
  */
3027
3113
  description: string | null;
3028
3114
  /**
3029
3115
  * Unit Label
3030
3116
  *
3031
- * この製品の単位を表すラベル。設定すると、Checkoutや請求書などに表示されます。（例：「個」、「ライセンス」、「時間」、「回」など）
3117
+ * この製品の単位を表すラベル。設定すると、Checkout や請求書などに表示されます。（例：「個」、「ライセンス」、「時間」、「回」など）
3032
3118
  */
3033
3119
  unit_label: string | null;
3034
3120
  /**
3035
3121
  * Url
3036
3122
  *
3037
- * この製品の公開されているウェブページのURL。
3123
+ * この製品の公開されているウェブページの URL
3038
3124
  */
3039
3125
  url: string | null;
3040
3126
  };
@@ -3067,42 +3153,42 @@ type ProductListResponse = {
3067
3153
  * ProductUpdateRequest
3068
3154
  */
3069
3155
  type ProductUpdateRequest = {
3156
+ /**
3157
+ * Name
3158
+ *
3159
+ * Checkout などで顧客に表示される商品名
3160
+ */
3161
+ name?: string;
3162
+ /**
3163
+ * Active
3164
+ *
3165
+ * 商品が購入可能かどうか
3166
+ */
3167
+ active?: boolean;
3070
3168
  /**
3071
3169
  * Default Price Id
3072
3170
  *
3073
- * この商品のデフォルト価格である価格オブジェクトのID。
3171
+ * この商品のデフォルト価格である価格オブジェクトの ID
3074
3172
  */
3075
3173
  default_price_id?: string;
3076
3174
  /**
3077
3175
  * Description
3078
3176
  *
3079
- * Checkoutなどで顧客に表示される商品説明。
3177
+ * Checkout などで顧客に表示される商品説明
3080
3178
  */
3081
3179
  description?: string;
3082
3180
  /**
3083
3181
  * Unit Label
3084
3182
  *
3085
- * この製品の単位を表すラベル。設定すると、Checkoutや請求書などに表示されます。（例：「個」、「ライセンス」、「時間」、「回」など）
3183
+ * この製品の単位を表すラベル。設定すると、Checkout などに表示されます。（例：「個」、「ライセンス」、「時間」、「回」など）
3086
3184
  */
3087
3185
  unit_label?: string;
3088
3186
  /**
3089
3187
  * Url
3090
3188
  *
3091
- * この製品の公開されているウェブページのURL。
3189
+ * この製品の公開されているウェブページの URL
3092
3190
  */
3093
3191
  url?: string;
3094
- /**
3095
- * Name
3096
- *
3097
- * Checkoutなどで顧客に表示される商品名。
3098
- */
3099
- name?: string;
3100
- /**
3101
- * Active
3102
- *
3103
- * 商品が購入可能かどうか。デフォルトは `true`。
3104
- */
3105
- active?: boolean;
3106
3192
  };
3107
3193
  /**
3108
3194
  * SetupFlowCancelRequest
@@ -3111,9 +3197,9 @@ type SetupFlowCancelRequest = {
3111
3197
  /**
3112
3198
  * この SetupFlow のキャンセル理由。
3113
3199
  *
3114
- * | 指定できる値 |
3200
+ * | 値 |
3115
3201
  * |:---|
3116
- * | **abandoned**: 顧客が支払いを完了しなかった場合。 |
3202
+ * | **abandoned**: 顧客が SetupFlow を完了しなかった場合。 |
3117
3203
  * | **requested_by_customer**: 顧客がキャンセルを要求した場合。 |
3118
3204
  * | **duplicate**: 支払い方法が重複している場合。 |
3119
3205
  */
@@ -3130,42 +3216,42 @@ type SetupFlowCreateRequest = {
3130
3216
  /**
3131
3217
  * Customer Id
3132
3218
  *
3133
- * この SetupFlow が属する顧客の ID。SetupFlow に PaymentMethod が設定されている場合、SetupFlow の設定が成功するとその PaymentMethod は顧客に紐付きます。別の顧客に紐付いている PaymentMethod をこの SetupFlow で使用することはできません。
3219
+ * この SetupFlow に関連付ける顧客の ID。SetupFlow により作られた PaymentMethod はこの顧客に紐付きます。
3134
3220
  */
3135
3221
  customer_id?: string;
3136
3222
  /**
3137
- * Description
3138
- *
3139
- * 説明。顧客に表示されます。
3140
- */
3141
- description?: string;
3142
- /**
3143
- * Metadata
3144
- *
3145
- * キーバリューの任意のデータを格納できます。<a href="https://docs.pay.jp/v2/metadata">詳細はメタデータのドキュメントを参照してください。</a>
3146
- */
3147
- metadata?: {
3148
- [key: string]: string | number | boolean;
3149
- };
3150
- /**
3151
- * この SetupFlow の支払い方法の個別設定。
3223
+ * この SetupFlow 固有の支払い方法の設定
3152
3224
  */
3153
3225
  payment_method_options?: SetupFlowPaymentMethodOptionsRequest;
3154
3226
  /**
3155
3227
  * Payment Method Types
3156
3228
  *
3157
- * この SetupFlow で使用できる支払い方法の種類（カードなど）のリストです。 指定しない場合、ダッシュボードで利用可能な状態にしている支払い方法が自動的に設定されます。
3229
+ * この SetupFlow で使用できる支払い方法の種類のリスト。 指定しない場合は、PAY.JP は支払い方法の設定から利用可能な支払い方法を動的に表示します。
3158
3230
  */
3159
3231
  payment_method_types?: Array<'card' | 'apple_pay'>;
3160
3232
  /**
3161
3233
  * 支払い方法が今後どのように使用されるかを指定します。指定されていない場合、この値はデフォルトで `off_session` になります。
3162
3234
  *
3163
- * | 指定できる値 |
3235
+ * | 値 |
3164
3236
  * |:---|
3165
3237
  * | **off_session**: 定期課金など、顧客がカートなどの決済フローにいるかどうか不明な場合は `off_session` を使用してください。 |
3166
3238
  * | **on_session**: 顧客がカートなどの決済フローにいる場合にのみ支払い方法を利用する場合は `on_session` を使用してください。 |
3167
3239
  */
3168
3240
  usage?: Usage;
3241
+ /**
3242
+ * Description
3243
+ *
3244
+ * 説明。顧客に表示されます。
3245
+ */
3246
+ description?: string;
3247
+ /**
3248
+ * Metadata
3249
+ *
3250
+ * キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href="https://docs.pay.jp/v2/guide/developers/metadata">詳細はメタデータのドキュメントを参照してください。</a>
3251
+ */
3252
+ metadata?: {
3253
+ [key: string]: string | number | boolean;
3254
+ };
3169
3255
  };
3170
3256
  /**
3171
3257
  * SetupFlowDataRequest
@@ -3174,7 +3260,7 @@ type SetupFlowDataRequest = {
3174
3260
  /**
3175
3261
  * Metadata
3176
3262
  *
3177
- * キーバリューの任意のデータを格納できます。<a href="https://docs.pay.jp/v2/metadata">詳細はメタデータのドキュメントを参照してください。</a>
3263
+ * キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href="https://docs.pay.jp/v2/guide/developers/metadata">詳細はメタデータのドキュメントを参照してください。</a>
3178
3264
  */
3179
3265
  metadata?: {
3180
3266
  [key: string]: string | number | boolean;
@@ -3212,12 +3298,12 @@ type SetupFlowPaymentMethodOptionsCardRequest = {
3212
3298
  /**
3213
3299
  * Request Three D Secure
3214
3300
  *
3215
- * 3Dセキュア認証の要求方法。
3301
+ * 3D セキュア認証の要求方法。
3216
3302
  *
3217
- * | 指定できる値 |
3303
+ * | 値 |
3218
3304
  * |:---|
3219
- * | **any**: 3Dセキュア認証を要求します。 |
3220
- * | **automatic**: 必要な場合にのみ3Dセキュア認証を要求します。 |
3305
+ * | **any**: 3D セキュア認証を要求します。 |
3306
+ * | **automatic**: 必要な場合にのみ 3D セキュア認証を要求します。 |
3221
3307
  */
3222
3308
  request_three_d_secure?: 'automatic' | 'any';
3223
3309
  };
@@ -3234,28 +3320,16 @@ type SetupFlowPaymentMethodOptionsRequest = {
3234
3320
  * SetupFlowResponse
3235
3321
  */
3236
3322
  type SetupFlowResponse = {
3237
- /**
3238
- * Id
3239
- *
3240
- * ID
3241
- */
3242
- id: string;
3243
3323
  /**
3244
3324
  * Object
3245
3325
  */
3246
3326
  object?: 'setup_flow';
3247
3327
  /**
3248
- * Created At
3249
- *
3250
- * 作成日時 (UTC, ISO 8601 形式)
3251
- */
3252
- created_at: string;
3253
- /**
3254
- * Updated At
3328
+ * Id
3255
3329
  *
3256
- * 更新日時 (UTC, ISO 8601 形式)
3330
+ * ID
3257
3331
  */
3258
- updated_at: string;
3332
+ id: string;
3259
3333
  /**
3260
3334
  * Livemode
3261
3335
  *
@@ -3265,13 +3339,13 @@ type SetupFlowResponse = {
3265
3339
  /**
3266
3340
  * Client Secret
3267
3341
  *
3268
- * この SetupFlow のクライアントシークレットです。フロントエンドで公開鍵と合わせて使用し、SetupFlow の取得や支払い処理を行います。**この値はこの SetupFlow の支払いを行う顧客以外へ公開しないでください。
3342
+ * この SetupFlow のクライアントシークレットです。フロントエンドで公開鍵と合わせて使用し、SetupFlow の取得や支払い方法の登録処理を行います。**この値はこの SetupFlow を利用する顧客以外へ公開しないでください。
3269
3343
  */
3270
3344
  client_secret: string;
3271
3345
  /**
3272
3346
  * Customer Id
3273
3347
  *
3274
- * この SetupFlow が属する顧客の ID。SetupFlow に PaymentMethod が設定されている場合、SetupFlow の設定が成功するとその PaymentMethod は顧客に紐付きます。別の顧客に紐付いている PaymentMethod をこの SetupFlow で使用することはできません。
3348
+ * この SetupFlow に関連付けられた顧客のID
3275
3349
  */
3276
3350
  customer_id: string | null;
3277
3351
  /**
@@ -3291,7 +3365,7 @@ type SetupFlowResponse = {
3291
3365
  /**
3292
3366
  * Payment Method Id
3293
3367
  *
3294
- * この SetupFlow に紐付ける決済方法のID
3368
+ * 支払い方法ID
3295
3369
  */
3296
3370
  payment_method_id: string | null;
3297
3371
  /**
@@ -3305,11 +3379,11 @@ type SetupFlowResponse = {
3305
3379
  /**
3306
3380
  * Payment Method Types
3307
3381
  *
3308
- * この SetupFlow で使用できる支払い方法の種類（カードなど）のリストです。 指定しない場合、ダッシュボードで利用可能な状態にしている支払い方法が自動的に設定されます。
3382
+ * この SetupFlow で使用できる支払い方法の種類のリスト
3309
3383
  */
3310
3384
  payment_method_types: Array<PaymentMethodTypes>;
3311
3385
  /**
3312
- * この SetupFlow のステータスです。<a href="https://docs.pay.jp/v2/setup_flows#status" target="_blank">ステータスの詳細についてはこちらをご覧ください。</a>
3386
+ * この SetupFlow のステータスです。<a href="https://docs.pay.jp/v2/guide/payments/setupflow#setup-flow-%E3%81%AE%E3%82%B9%E3%83%86%E3%83%BC%E3%82%BF%E3%82%B9" target="_blank">ステータスの詳細についてはこちらをご覧ください。</a>
3313
3387
  *
3314
3388
  * | 値 |
3315
3389
  * |:---|
@@ -3332,17 +3406,39 @@ type SetupFlowResponse = {
3332
3406
  /**
3333
3407
  * Return Url
3334
3408
  *
3335
- * 顧客が支払いを完了後、あるいはキャンセルした後にリダイレクトされるURL。アプリにリダイレクトしたい場合は URI Scheme を指定できます。`confirm=true` の場合のみ指定できます。
3409
+ * 顧客が支払い方法の登録を完了後、あるいはキャンセルした後にリダイレクトされる URL
3336
3410
  */
3337
3411
  return_url: string | null;
3338
3412
  /**
3339
3413
  * Last Setup Error
3340
3414
  *
3341
- * この SetupFlow で発生した最後のエラーです。
3415
+ * この SetupFlow で発生した最後のエラー
3342
3416
  */
3343
3417
  last_setup_error: {
3344
3418
  [key: string]: unknown;
3345
3419
  } | null;
3420
+ /**
3421
+ * この SetupFlow がキャンセルされた理由
3422
+ *
3423
+ * | 値 |
3424
+ * |:---|
3425
+ * | **abandoned**: 放棄、中断 |
3426
+ * | **duplicate**: 重複 |
3427
+ * | **requested_by_customer**: 顧客からの要請 |
3428
+ */
3429
+ cancellation_reason: SetupFlowCancellationReason | null;
3430
+ /**
3431
+ * Created At
3432
+ *
3433
+ * 作成日時 (UTC, ISO 8601 形式)
3434
+ */
3435
+ created_at: string;
3436
+ /**
3437
+ * Updated At
3438
+ *
3439
+ * 更新日時 (UTC, ISO 8601 形式)
3440
+ */
3441
+ updated_at: string;
3346
3442
  };
3347
3443
  /**
3348
3444
  * SetupFlowStatus
@@ -3355,17 +3451,17 @@ type SetupFlowUpdateRequest = {
3355
3451
  /**
3356
3452
  * Customer Id
3357
3453
  *
3358
- * この SetupFlow が属する顧客の ID。SetupFlow に PaymentMethod が設定されている場合、SetupFlow の設定が成功するとその PaymentMethod は顧客に紐付きます。別の顧客に紐付いている PaymentMethod をこの SetupFlow で使用することはできません。
3454
+ * この SetupFlow に関連付ける顧客の ID。SetupFlow により作られた PaymentMethod はこの顧客に紐付きます。
3359
3455
  */
3360
3456
  customer_id?: string;
3361
3457
  /**
3362
- * この SetupFlow の支払い方法の個別設定。
3458
+ * この SetupFlow 固有の支払い方法の設定
3363
3459
  */
3364
3460
  payment_method_options?: SetupFlowPaymentMethodOptionsRequest;
3365
3461
  /**
3366
3462
  * Payment Method Types
3367
3463
  *
3368
- * この SetupFlow で使用できる支払い方法の種類（カードなど）のリストです。 指定しない場合、ダッシュボードで利用可能な状態にしている支払い方法が自動的に設定されます。
3464
+ * この SetupFlow で使用できる支払い方法の種類のリスト。 指定しない場合は、PAY.JP は支払い方法の設定から利用可能な支払い方法を動的に表示します。
3369
3465
  */
3370
3466
  payment_method_types?: Array<'card' | 'apple_pay'>;
3371
3467
  /**
@@ -3377,7 +3473,7 @@ type SetupFlowUpdateRequest = {
3377
3473
  /**
3378
3474
  * Metadata
3379
3475
  *
3380
- * キーバリューの任意のデータを格納できます。<a href="https://docs.pay.jp/v2/metadata">詳細はメタデータのドキュメントを参照してください。</a>
3476
+ * キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href="https://docs.pay.jp/v2/guide/developers/metadata">詳細はメタデータのドキュメントを参照してください。</a>
3381
3477
  */
3382
3478
  metadata?: {
3383
3479
  [key: string]: string | number | boolean;
@@ -3406,7 +3502,7 @@ type StatementItemResponse = {
3406
3502
  /**
3407
3503
  * Tax Rate
3408
3504
  *
3409
- * 税率（パーセンテージ）
3505
+ * 税率（%）
3410
3506
  */
3411
3507
  tax_rate: string | null;
3412
3508
  };
@@ -3446,7 +3542,7 @@ type StatementResponse = {
3446
3542
  /**
3447
3543
  * Id
3448
3544
  *
3449
- * 明細ID
3545
+ * 明細 ID
3450
3546
  */
3451
3547
  id: string;
3452
3548
  /**
@@ -3464,38 +3560,23 @@ type StatementResponse = {
3464
3560
  /**
3465
3561
  * 取引明細の区分
3466
3562
  *
3467
- * | 名 | 区分 | 詳細 |
3563
+ * | 値 | 区分 | 詳細 |
3468
3564
  * |---| --- | --- |
3469
3565
  * | **sales** | 売上 | 決済による売上、決済手数料等 |
3470
- * | **service_fee** | サービス利用料 | 有料プランの月額費用など、salesに含まれないサービス利用料 |
3566
+ * | **service_fee** | サービス利用料 | 有料プランの月額費用など、sales に含まれないサービス利用料 |
3471
3567
  * | **forfeit** | 残高失効 | - |
3472
3568
  * | **transfer_fee** | 振込手数料 | - |
3473
3569
  * | **misc** | その他 | 調整金など |
3474
3570
  */
3475
3571
  type: StatementType;
3476
3572
  /**
3477
- * Created At
3478
- *
3479
- * 更新時の日時 (UTC, ISO 8601 形式)
3480
- */
3481
- created_at: string;
3482
- /**
3483
- * Updated At
3484
- *
3485
- * 更新時の日時 (UTC, ISO 8601 形式)
3486
- */
3487
- updated_at: string;
3488
- /**
3489
- * このStatementが関連付けられているTermオブジェクト
3490
- *
3491
- * このStatementの生成元となったTermオブジェクト プロプラン料金や各種手数料など、Termから作られていないものではnullになります。
3492
- *
3573
+ * この Statement の生成元となった Term オブジェクト。プロプラン料金や各種手数料など、Term から作られていないものでは null になります。
3493
3574
  */
3494
3575
  term: TermResponse | null;
3495
3576
  /**
3496
3577
  * Balance Id
3497
3578
  *
3498
- * 該当する場合の残高ID
3579
+ * 残高 ID
3499
3580
  */
3500
3581
  balance_id: string | null;
3501
3582
  /**
@@ -3507,9 +3588,21 @@ type StatementResponse = {
3507
3588
  /**
3508
3589
  * Net
3509
3590
  *
3510
- * 含まれるstatement_itemの金額合計
3591
+ * 含まれる statement_item の金額合計
3511
3592
  */
3512
3593
  net: number;
3594
+ /**
3595
+ * Created At
3596
+ *
3597
+ * 作成日時 (UTC, ISO 8601 形式)
3598
+ */
3599
+ created_at: string;
3600
+ /**
3601
+ * Updated At
3602
+ *
3603
+ * 更新日時 (UTC, ISO 8601 形式)
3604
+ */
3605
+ updated_at: string;
3513
3606
  };
3514
3607
  /**
3515
3608
  * StatementSubject
@@ -3549,13 +3642,13 @@ type StatementUrlResponse = {
3549
3642
  /**
3550
3643
  * Url
3551
3644
  *
3552
- * 取引明細書ダウンロードURL
3645
+ * 取引明細書ダウンロード URL
3553
3646
  */
3554
3647
  url: string;
3555
3648
  /**
3556
3649
  * Expires
3557
3650
  *
3558
- * 有効期限の日付。
3651
+ * 有効期限の日付
3559
3652
  *
3560
3653
  * 有効期限は発行から1時間です。
3561
3654
  */
@@ -3580,7 +3673,7 @@ type TaxRateCreateRequest = {
3580
3673
  /**
3581
3674
  * Percentage
3582
3675
  *
3583
- * 税率を % 単位で指定します（例： 10%の場合は「10」と入力）
3676
+ * 税率を % 単位で指定します（例: 10%の場合は「10」と入力）
3584
3677
  */
3585
3678
  percentage: number;
3586
3679
  /**
@@ -3596,13 +3689,13 @@ type TaxRateCreateRequest = {
3596
3689
  /**
3597
3690
  * Description
3598
3691
  *
3599
- * 説明。ダッシュボード内のみで表示され、顧客には表示されません。
3692
+ * 説明。管理画面内のみで表示され、顧客には表示されません。
3600
3693
  */
3601
3694
  description?: string;
3602
3695
  /**
3603
3696
  * Metadata
3604
3697
  *
3605
- * キーバリューの任意のデータを格納できます。<a href="https://docs.pay.jp/v2/metadata">詳細はメタデータのドキュメントを参照してください。</a>
3698
+ * キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href="https://docs.pay.jp/v2/guide/developers/metadata">詳細はメタデータのドキュメントを参照してください。</a>
3606
3699
  */
3607
3700
  metadata?: {
3608
3701
  [key: string]: string | number | boolean;
@@ -3619,7 +3712,7 @@ type TaxRateDetailsResponse = {
3619
3712
  /**
3620
3713
  * Id
3621
3714
  *
3622
- * ID
3715
+ * 税率 ID
3623
3716
  */
3624
3717
  id: string;
3625
3718
  /**
@@ -3637,23 +3730,23 @@ type TaxRateDetailsResponse = {
3637
3730
  /**
3638
3731
  * Percentage
3639
3732
  *
3640
- * 税率を % 単位で指定します（例： 10%の場合は「10」と入力）
3733
+ * 税率 (% 単位)
3641
3734
  */
3642
3735
  percentage: number;
3643
3736
  /**
3644
3737
  * Active
3645
3738
  *
3646
- * この税率が有効であるかどうか。無効にした場合でも、すでに設定されている定期課金などでは使用可能です。
3739
+ * この税率が有効であるかどうか
3647
3740
  */
3648
3741
  active: boolean;
3649
3742
  /**
3650
- * 有効な2文字の <a href="https://ja.wikipedia.org/wiki/ISO_3166-1" target="_blank">ISO 国コード</a>
3743
+ * 2文字の <a href="https://ja.wikipedia.org/wiki/ISO_3166-1" target="_blank">ISO 国コード</a>
3651
3744
  */
3652
3745
  country: Country | null;
3653
3746
  /**
3654
3747
  * Description
3655
3748
  *
3656
- * 説明。ダッシュボード内のみで表示され、顧客には表示されません。
3749
+ * 説明。管理画面内のみで表示され、顧客には表示されません。
3657
3750
  */
3658
3751
  description: string | null;
3659
3752
  /**
@@ -3707,7 +3800,7 @@ type TaxRateUpdateRequest = {
3707
3800
  /**
3708
3801
  * Description
3709
3802
  *
3710
- * 説明。ダッシュボード内のみで表示され、顧客には表示されません。
3803
+ * 説明。管理画面内のみで表示され、顧客には表示されません。
3711
3804
  */
3712
3805
  description?: string;
3713
3806
  /**
@@ -3719,7 +3812,7 @@ type TaxRateUpdateRequest = {
3719
3812
  /**
3720
3813
  * Metadata
3721
3814
  *
3722
- * キーバリューの任意のデータを格納できます。<a href="https://docs.pay.jp/v2/metadata">詳細はメタデータのドキュメントを参照してください。</a>
3815
+ * キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href="https://docs.pay.jp/v2/guide/developers/metadata">詳細はメタデータのドキュメントを参照してください。</a>
3723
3816
  */
3724
3817
  metadata?: {
3725
3818
  [key: string]: string | number | boolean;
@@ -3754,16 +3847,16 @@ type TermListResponse = {
3754
3847
  * TermResponse
3755
3848
  */
3756
3849
  type TermResponse = {
3850
+ /**
3851
+ * Object
3852
+ */
3853
+ object?: 'term';
3757
3854
  /**
3758
3855
  * Id
3759
3856
  *
3760
- * ID
3857
+ * 集計区間 ID
3761
3858
  */
3762
3859
  id: string;
3763
- /**
3764
- * Object
3765
- */
3766
- object?: 'term';
3767
3860
  /**
3768
3861
  * Livemode
3769
3862
  *
@@ -3781,15 +3874,14 @@ type TermResponse = {
3781
3874
  *
3782
3875
  * 区間終了時刻
3783
3876
  *
3784
- * Termが表す区間はstart_at 以上 end_at 未満 の範囲となります。
3785
- * 翌サイクルのTermの場合nullを返します。
3786
- *
3877
+ * Term が表す区間は start_at 以上 end_at 未満の範囲となります。
3878
+ * 翌サイクルの Term の場合 null を返します。
3787
3879
  */
3788
3880
  end_at: string;
3789
3881
  /**
3790
3882
  * Closed
3791
3883
  *
3792
- * 締め処理が完了済みならTrue
3884
+ * 締め処理が完了済みなら true
3793
3885
  */
3794
3886
  closed: boolean;
3795
3887
  };
@@ -3797,21 +3889,6 @@ type TermResponse = {
3797
3889
  * Usage
3798
3890
  */
3799
3891
  type Usage = 'on_session' | 'off_session';
3800
- /**
3801
- * ProductDeletedResponse
3802
- */
3803
- type ProductDeletedResponseWritable = {
3804
- /**
3805
- * Id
3806
- *
3807
- * 商品ID
3808
- */
3809
- id: string;
3810
- /**
3811
- * Object
3812
- */
3813
- object?: 'product';
3814
- };
3815
3892
  type GetAllPaymentMethodsData = {
3816
3893
  body?: never;
3817
3894
  path?: never;
@@ -3920,6 +3997,10 @@ type UpdatePaymentMethodData = {
3920
3997
  url: '/v2/payment_methods/{payment_method_id}';
3921
3998
  };
3922
3999
  type UpdatePaymentMethodErrors = {
4000
+ /**
4001
+ * Metadata Limit Exceeded
4002
+ */
4003
+ 400: ErrorResponse;
3923
4004
  /**
3924
4005
  * Not Found
3925
4006
  */
@@ -3979,7 +4060,7 @@ type AttachPaymentMethodData = {
3979
4060
  };
3980
4061
  type AttachPaymentMethodErrors = {
3981
4062
  /**
3982
- * Payment Method Already Attached<br>Unsupported Payment Method Type
4063
+ * Payment Method Already Attached<br>Payment Method Customer Mismatch<br>Unsupported Payment Method Type
3983
4064
  */
3984
4065
  400: ErrorResponse;
3985
4066
  /**
@@ -4171,6 +4252,10 @@ type CreateProductData = {
4171
4252
  url: '/v2/products';
4172
4253
  };
4173
4254
  type CreateProductErrors = {
4255
+ /**
4256
+ * Already Exists ID
4257
+ */
4258
+ 400: ErrorResponse;
4174
4259
  /**
4175
4260
  * Validation Error
4176
4261
  */
@@ -4196,6 +4281,14 @@ type DeleteProductData = {
4196
4281
  url: '/v2/products/{product_id}';
4197
4282
  };
4198
4283
  type DeleteProductErrors = {
4284
+ /**
4285
+ * Product Has Prices
4286
+ */
4287
+ 400: ErrorResponse;
4288
+ /**
4289
+ * Not Found
4290
+ */
4291
+ 404: ErrorResponse;
4199
4292
  /**
4200
4293
  * Validation Error
4201
4294
  */
@@ -4221,6 +4314,10 @@ type GetProductData = {
4221
4314
  url: '/v2/products/{product_id}';
4222
4315
  };
4223
4316
  type GetProductErrors = {
4317
+ /**
4318
+ * Not Found
4319
+ */
4320
+ 404: ErrorResponse;
4224
4321
  /**
4225
4322
  * Validation Error
4226
4323
  */
@@ -4246,6 +4343,14 @@ type UpdateProductData = {
4246
4343
  url: '/v2/products/{product_id}';
4247
4344
  };
4248
4345
  type UpdateProductErrors = {
4346
+ /**
4347
+ * Invalid Default Price
4348
+ */
4349
+ 400: ErrorResponse;
4350
+ /**
4351
+ * Not Found
4352
+ */
4353
+ 404: ErrorResponse;
4249
4354
  /**
4250
4355
  * Validation Error
4251
4356
  */
@@ -4284,7 +4389,7 @@ type GetAllPricesData = {
4284
4389
  /**
4285
4390
  * Lookup Keys
4286
4391
  *
4287
- * 価格を動的に取得するために使用される検索キー。
4392
+ * 価格を動的に取得するために使用される検索キー
4288
4393
  */
4289
4394
  lookup_keys?: Array<string>;
4290
4395
  };
@@ -4315,6 +4420,10 @@ type CreatePriceData = {
4315
4420
  url: '/v2/prices';
4316
4421
  };
4317
4422
  type CreatePriceErrors = {
4423
+ /**
4424
+ * Not Found
4425
+ */
4426
+ 404: ErrorResponse;
4318
4427
  /**
4319
4428
  * Validation Error
4320
4429
  */
@@ -4365,6 +4474,14 @@ type UpdatePriceData = {
4365
4474
  url: '/v2/prices/{price_id}';
4366
4475
  };
4367
4476
  type UpdatePriceErrors = {
4477
+ /**
4478
+ * Metadata Limit Exceeded
4479
+ */
4480
+ 400: ErrorResponse;
4481
+ /**
4482
+ * Not Found
4483
+ */
4484
+ 404: ErrorResponse;
4368
4485
  /**
4369
4486
  * Validation Error
4370
4487
  */
@@ -4420,7 +4537,7 @@ type UpdatePaymentFlowData = {
4420
4537
  };
4421
4538
  type UpdatePaymentFlowErrors = {
4422
4539
  /**
4423
- * Invalid Status<br>Detached Payment Method Not Usable<br>Payment Method Not Owned By Customer<br>Payment Method Type Not Allowed
4540
+ * Invalid Status<br>Detached Payment Method Not Usable<br>Payment Method Not Owned By Customer<br>Payment Method Type Not Allowed<br>Metadata Limit Exceeded
4424
4541
  */
4425
4542
  400: ErrorResponse;
4426
4543
  /**
@@ -4718,6 +4835,10 @@ type UpdatePaymentRefundData = {
4718
4835
  url: '/v2/payment_refunds/{payment_refund_id}';
4719
4836
  };
4720
4837
  type UpdatePaymentRefundErrors = {
4838
+ /**
4839
+ * Metadata Limit Exceeded
4840
+ */
4841
+ 400: ErrorResponse;
4721
4842
  /**
4722
4843
  * Not Found
4723
4844
  */
@@ -4848,7 +4969,7 @@ type UpdateSetupFlowData = {
4848
4969
  };
4849
4970
  type UpdateSetupFlowErrors = {
4850
4971
  /**
4851
- * Detached Payment Method Not Usable
4972
+ * Detached Payment Method Not Usable<br>Metadata Limit Exceeded
4852
4973
  */
4853
4974
  400: ErrorResponse;
4854
4975
  /**
@@ -5048,7 +5169,7 @@ type GetAllStatementsData = {
5048
5169
  /**
5049
5170
  * Term Id
5050
5171
  *
5051
- * 期間IDでフィルタ
5172
+ * 集計区間 ID でフィルタ
5052
5173
  */
5053
5174
  term_id?: string;
5054
5175
  };
@@ -5165,29 +5286,27 @@ type GetAllBalancesData = {
5165
5286
  */
5166
5287
  ending_before?: string;
5167
5288
  /**
5168
- * State
5169
- *
5170
- * stateが指定した値であるオブジェクトに限定
5289
+ * state が指定した値であるオブジェクトに限定
5171
5290
  */
5172
- state?: BalanceState | null;
5291
+ state?: BalanceState;
5173
5292
  /**
5174
5293
  * Closed
5175
5294
  *
5176
- * closedが指定した値であるオブジェクトに限定
5295
+ * closed が指定した値であるオブジェクトに限定
5177
5296
  */
5178
- closed?: boolean | null;
5297
+ closed?: boolean;
5179
5298
  /**
5180
5299
  * Since Due Date
5181
5300
  *
5182
5301
  * 入金予定日/振込期限日が指定した日時以降のデータのみ取得
5183
5302
  */
5184
- since_due_date?: string | null;
5303
+ since_due_date?: string;
5185
5304
  /**
5186
5305
  * Until Due Date
5187
5306
  *
5188
5307
  * 入金予定日/振込期限日が指定した日時以前のデータのみ取得
5189
5308
  */
5190
- until_due_date?: string | null;
5309
+ until_due_date?: string;
5191
5310
  };
5192
5311
  url: '/v2/balances';
5193
5312
  };
@@ -5346,6 +5465,10 @@ type UpdateCheckoutSessionData = {
5346
5465
  url: '/v2/checkout/sessions/{checkout_session_id}';
5347
5466
  };
5348
5467
  type UpdateCheckoutSessionErrors = {
5468
+ /**
5469
+ * Metadata Limit Exceeded
5470
+ */
5471
+ 400: ErrorResponse;
5349
5472
  /**
5350
5473
  * Not Found
5351
5474
  */
@@ -5515,6 +5638,14 @@ type UpdateTaxRateData = {
5515
5638
  url: '/v2/tax_rates/{tax_rate_id}';
5516
5639
  };
5517
5640
  type UpdateTaxRateErrors = {
5641
+ /**
5642
+ * Metadata Limit Exceeded
5643
+ */
5644
+ 400: ErrorResponse;
5645
+ /**
5646
+ * Not Found
5647
+ */
5648
+ 404: ErrorResponse;
5518
5649
  /**
5519
5650
  * Validation Error
5520
5651
  */
@@ -5669,6 +5800,10 @@ type UpdateCustomerData = {
5669
5800
  url: '/v2/customers/{customer_id}';
5670
5801
  };
5671
5802
  type UpdateCustomerErrors = {
5803
+ /**
5804
+ * Metadata Limit Exceeded
5805
+ */
5806
+ 400: ErrorResponse;
5672
5807
  /**
5673
5808
  * Not Found
5674
5809
  */
@@ -5763,19 +5898,19 @@ type GetAllEventsData = {
5763
5898
  /**
5764
5899
  * Resource Id
5765
5900
  *
5766
- * 取得するeventに紐づくAPIリソースのID (e.g. customer.id)
5901
+ * 取得する event に紐づく API リソースの ID
5767
5902
  */
5768
5903
  resource_id?: string;
5769
5904
  /**
5770
5905
  * Object
5771
5906
  *
5772
- * 取得するeventに紐づくAPIリソースのobject。値はリソース名(e.g. customer, payment_flow)
5907
+ * 取得する event に紐づく API リソースの object。値はリソース名 (e.g. customer, payment_flow)
5773
5908
  */
5774
5909
  object?: string;
5775
5910
  /**
5776
5911
  * Type
5777
5912
  *
5778
- * 取得するeventのtype
5913
+ * 取得する event の type
5779
5914
  */
5780
5915
  type?: string;
5781
5916
  };
@@ -5882,7 +6017,7 @@ type GetAllPaymentTransactionsData = {
5882
6017
  /**
5883
6018
  * Term Id
5884
6019
  *
5885
- * term ID
6020
+ * 集計区間 ID
5886
6021
  */
5887
6022
  term_id?: string;
5888
6023
  /**
@@ -5972,13 +6107,13 @@ type GetAllTermsData = {
5972
6107
  /**
5973
6108
  * Since Start At
5974
6109
  *
5975
- * start_atが指定した日付以降のデータを取得
6110
+ * start_at が指定した日付以降のデータを取得
5976
6111
  */
5977
6112
  since_start_at?: string;
5978
6113
  /**
5979
6114
  * Until Start At
5980
6115
  *
5981
- * start_atが指定した日付以前のデータを取得
6116
+ * start_at が指定した日付以前のデータを取得
5982
6117
  */
5983
6118
  until_start_at?: string;
5984
6119
  };
@@ -6272,5 +6407,5 @@ declare const getTerm: <ThrowOnError extends boolean = false>(options: Options<G
6272
6407
  */
6273
6408
  declare const getAllTerms: <ThrowOnError extends boolean = false>(options?: Options<GetAllTermsData, ThrowOnError>) => RequestResult<GetAllTermsResponses, GetAllTermsErrors, ThrowOnError, "fields">;
6274
6409
  //#endregion
6275
- export { AttachPaymentMethodData, AttachPaymentMethodError, AttachPaymentMethodErrors, AttachPaymentMethodResponse, AttachPaymentMethodResponses, BalanceListResponse, BalanceResponse, BalanceState, BalanceUrlResponse, BankInfoResponse, CancelPaymentFlowData, CancelPaymentFlowError, CancelPaymentFlowErrors, CancelPaymentFlowResponse, CancelPaymentFlowResponses, CancelSetupFlowData, CancelSetupFlowError, CancelSetupFlowErrors, CancelSetupFlowResponse, CancelSetupFlowResponses, CaptureMethod, CapturePaymentFlowData, CapturePaymentFlowError, CapturePaymentFlowErrors, CapturePaymentFlowResponse, CapturePaymentFlowResponses, CardConfigRequest, CheckoutSessionCreateRequest, CheckoutSessionDetailsResponse, CheckoutSessionLineItemDataResponse, CheckoutSessionLineItemListResponse, CheckoutSessionListResponse, CheckoutSessionMode, CheckoutSessionPaymentMethodOptionsCardRequest, CheckoutSessionPaymentMethodOptionsRequest, CheckoutSessionStatus, CheckoutSessionSubmitType, CheckoutSessionUiMode, CheckoutSessionUpdateRequest, type Client, type ClientConfig, ClientOptions, ConfirmPaymentFlowData, ConfirmPaymentFlowError, ConfirmPaymentFlowErrors, ConfirmPaymentFlowResponse, ConfirmPaymentFlowResponses, Country, CreateBalanceUrlData, CreateBalanceUrlError, CreateBalanceUrlErrors, CreateBalanceUrlResponse, CreateBalanceUrlResponses, CreateCheckoutSessionData, CreateCheckoutSessionError, CreateCheckoutSessionErrors, CreateCheckoutSessionResponse, CreateCheckoutSessionResponses, CreateCustomerData, CreateCustomerError, CreateCustomerErrors, CreateCustomerResponse, CreateCustomerResponses, CreatePaymentFlowData, CreatePaymentFlowError, CreatePaymentFlowErrors, CreatePaymentFlowResponse, CreatePaymentFlowResponses, CreatePaymentMethodData, CreatePaymentMethodError, CreatePaymentMethodErrors, CreatePaymentMethodResponse, CreatePaymentMethodResponses, CreatePaymentRefundData, CreatePaymentRefundError, CreatePaymentRefundErrors, CreatePaymentRefundResponse, CreatePaymentRefundResponses, CreatePriceData, CreatePriceError, CreatePriceErrors, CreatePriceResponse, CreatePriceResponses, CreateProductData, CreateProductError, CreateProductErrors, CreateProductResponse, CreateProductResponses, CreateSetupFlowData, CreateSetupFlowError, CreateSetupFlowErrors, CreateSetupFlowResponse, CreateSetupFlowResponses, CreateStatementUrlData, CreateStatementUrlError, CreateStatementUrlErrors, CreateStatementUrlResponse, CreateStatementUrlResponses, CreateTaxRateData, CreateTaxRateError, CreateTaxRateErrors, CreateTaxRateResponse, CreateTaxRateResponses, Currency, CustomerCreateRequest, CustomerCreation, CustomerListResponse, CustomerResponse, CustomerUpdateRequest, DeleteCustomerData, DeleteCustomerError, DeleteCustomerErrors, DeleteCustomerResponse, DeleteCustomerResponses, DeleteProductData, DeleteProductError, DeleteProductErrors, DeleteProductResponse, DeleteProductResponses, DetachPaymentMethodData, DetachPaymentMethodError, DetachPaymentMethodErrors, DetachPaymentMethodResponse, DetachPaymentMethodResponses, DisplayPreferenceRequest, ErrorResponse, EventListResponse, EventResponse, GetAllBalancesData, GetAllBalancesError, GetAllBalancesErrors, GetAllBalancesResponse, GetAllBalancesResponses, GetAllCheckoutSessionLineItemsData, GetAllCheckoutSessionLineItemsError, GetAllCheckoutSessionLineItemsErrors, GetAllCheckoutSessionLineItemsResponse, GetAllCheckoutSessionLineItemsResponses, GetAllCheckoutSessionsData, GetAllCheckoutSessionsError, GetAllCheckoutSessionsErrors, GetAllCheckoutSessionsResponse, GetAllCheckoutSessionsResponses, GetAllCustomersData, GetAllCustomersError, GetAllCustomersErrors, GetAllCustomersResponse, GetAllCustomersResponses, GetAllEventsData, GetAllEventsError, GetAllEventsErrors, GetAllEventsResponse, GetAllEventsResponses, GetAllPaymentFlowsData, GetAllPaymentFlowsError, GetAllPaymentFlowsErrors, GetAllPaymentFlowsResponse, GetAllPaymentFlowsResponses, GetAllPaymentMethodConfigurationsData, GetAllPaymentMethodConfigurationsError, GetAllPaymentMethodConfigurationsErrors, GetAllPaymentMethodConfigurationsResponse, GetAllPaymentMethodConfigurationsResponses, GetAllPaymentMethodsData, GetAllPaymentMethodsError, GetAllPaymentMethodsErrors, GetAllPaymentMethodsResponse, GetAllPaymentMethodsResponses, GetAllPaymentRefundsData, GetAllPaymentRefundsError, GetAllPaymentRefundsErrors, GetAllPaymentRefundsResponse, GetAllPaymentRefundsResponses, GetAllPaymentTransactionsData, GetAllPaymentTransactionsError, GetAllPaymentTransactionsErrors, GetAllPaymentTransactionsResponse, GetAllPaymentTransactionsResponses, GetAllPricesData, GetAllPricesError, GetAllPricesErrors, GetAllPricesResponse, GetAllPricesResponses, GetAllProductsData, GetAllProductsError, GetAllProductsErrors, GetAllProductsResponse, GetAllProductsResponses, GetAllSetupFlowsData, GetAllSetupFlowsError, GetAllSetupFlowsErrors, GetAllSetupFlowsResponse, GetAllSetupFlowsResponses, GetAllStatementsData, GetAllStatementsError, GetAllStatementsErrors, GetAllStatementsResponse, GetAllStatementsResponses, GetAllTaxRatesData, GetAllTaxRatesError, GetAllTaxRatesErrors, GetAllTaxRatesResponse, GetAllTaxRatesResponses, GetAllTermsData, GetAllTermsError, GetAllTermsErrors, GetAllTermsResponse, GetAllTermsResponses, GetBalanceData, GetBalanceError, GetBalanceErrors, GetBalanceResponse, GetBalanceResponses, GetCheckoutSessionData, GetCheckoutSessionError, GetCheckoutSessionErrors, GetCheckoutSessionResponse, GetCheckoutSessionResponses, GetCustomerData, GetCustomerError, GetCustomerErrors, GetCustomerPaymentMethodsData, GetCustomerPaymentMethodsError, GetCustomerPaymentMethodsErrors, GetCustomerPaymentMethodsResponse, GetCustomerPaymentMethodsResponses, GetCustomerResponse, GetCustomerResponses, GetEventData, GetEventError, GetEventErrors, GetEventResponse, GetEventResponses, GetPaymentFlowData, GetPaymentFlowError, GetPaymentFlowErrors, GetPaymentFlowRefundsData, GetPaymentFlowRefundsError, GetPaymentFlowRefundsErrors, GetPaymentFlowRefundsResponse, GetPaymentFlowRefundsResponses, GetPaymentFlowResponse, GetPaymentFlowResponses, GetPaymentMethodByCardData, GetPaymentMethodByCardError, GetPaymentMethodByCardErrors, GetPaymentMethodByCardResponse, GetPaymentMethodByCardResponses, GetPaymentMethodConfigurationData, GetPaymentMethodConfigurationError, GetPaymentMethodConfigurationErrors, GetPaymentMethodConfigurationResponse, GetPaymentMethodConfigurationResponses, GetPaymentMethodData, GetPaymentMethodError, GetPaymentMethodErrors, GetPaymentMethodResponse, GetPaymentMethodResponses, GetPaymentRefundData, GetPaymentRefundError, GetPaymentRefundErrors, GetPaymentRefundResponse, GetPaymentRefundResponses, GetPaymentTransactionData, GetPaymentTransactionError, GetPaymentTransactionErrors, GetPaymentTransactionResponse, GetPaymentTransactionResponses, GetPriceData, GetPriceError, GetPriceErrors, GetPriceResponse, GetPriceResponses, GetProductData, GetProductError, GetProductErrors, GetProductResponse, GetProductResponses, GetSetupFlowData, GetSetupFlowError, GetSetupFlowErrors, GetSetupFlowResponse, GetSetupFlowResponses, GetStatementData, GetStatementError, GetStatementErrors, GetStatementResponse, GetStatementResponses, GetTaxRateData, GetTaxRateError, GetTaxRateErrors, GetTaxRateResponse, GetTaxRateResponses, GetTermData, GetTermError, GetTermErrors, GetTermResponse, GetTermResponses, LineItemRequest, Locale, Options, PayPayConfigRequest, PaymentFlowCancelRequest, PaymentFlowCaptureRequest, PaymentFlowConfirmRequest, PaymentFlowCreateRequest, PaymentFlowDataRequest, PaymentFlowListResponse, PaymentFlowPaymentMethodOptionsCardRequest, PaymentFlowPaymentMethodOptionsRequest, PaymentFlowResponse, PaymentFlowStatus, PaymentFlowUpdateRequest, PaymentMethodApplePayCreateRequest, PaymentMethodApplePayUpdateRequest, PaymentMethodAttachRequest, PaymentMethodBillingAddressRequest, PaymentMethodBillingAddressResponse, PaymentMethodBillingDetailsRequest, PaymentMethodBillingDetailsResponse, PaymentMethodCardBillingDetailsRequest, PaymentMethodCardCreateRequest, PaymentMethodCardDetailsResponse, PaymentMethodCardResponse, PaymentMethodCardUpdateRequest, PaymentMethodConfigurationDetailsResponse, PaymentMethodConfigurationDisplayPreference, PaymentMethodConfigurationListResponse, PaymentMethodConfigurationSettingResponse, PaymentMethodConfigurationUpdateRequest, PaymentMethodCreateCardDetailsRequest, PaymentMethodCreateRequest, PaymentMethodListResponse, PaymentMethodPayPayCreateRequest, PaymentMethodPayPayResponse, PaymentMethodPayPayUpdateRequest, PaymentMethodResponse, PaymentMethodTypes, PaymentMethodUpdateRequest, PaymentRefundCreateRequest, PaymentRefundListResponse, PaymentRefundReason, PaymentRefundResponse, PaymentRefundStatus, PaymentRefundUpdateRequest, PaymentTransactionListResponse, PaymentTransactionResponse, PaymentTransactionType, PriceCreateRequest, PriceDetailsResponse, PriceListResponse, PriceType, PriceUpdateRequest, ProductCreateRequest, ProductDeletedResponse, ProductDeletedResponseWritable, ProductDetailsResponse, ProductListResponse, ProductUpdateRequest, SetupFlowCancelRequest, SetupFlowCancellationReason, SetupFlowCreateRequest, SetupFlowDataRequest, SetupFlowListResponse, SetupFlowPaymentMethodOptionsCardRequest, SetupFlowPaymentMethodOptionsRequest, SetupFlowResponse, SetupFlowStatus, SetupFlowUpdateRequest, StatementItemResponse, StatementListResponse, StatementResponse, StatementSubject, StatementType, StatementUrlResponse, TaxRateCreateRequest, TaxRateDetailsResponse, TaxRateListResponse, TaxRateUpdateRequest, TermListResponse, TermResponse, UpdateCheckoutSessionData, UpdateCheckoutSessionError, UpdateCheckoutSessionErrors, UpdateCheckoutSessionResponse, UpdateCheckoutSessionResponses, UpdateCustomerData, UpdateCustomerError, UpdateCustomerErrors, UpdateCustomerResponse, UpdateCustomerResponses, UpdatePaymentFlowData, UpdatePaymentFlowError, UpdatePaymentFlowErrors, UpdatePaymentFlowResponse, UpdatePaymentFlowResponses, UpdatePaymentMethodConfigurationData, UpdatePaymentMethodConfigurationError, UpdatePaymentMethodConfigurationErrors, UpdatePaymentMethodConfigurationResponse, UpdatePaymentMethodConfigurationResponses, UpdatePaymentMethodData, UpdatePaymentMethodError, UpdatePaymentMethodErrors, UpdatePaymentMethodResponse, UpdatePaymentMethodResponses, UpdatePaymentRefundData, UpdatePaymentRefundError, UpdatePaymentRefundErrors, UpdatePaymentRefundResponse, UpdatePaymentRefundResponses, UpdatePriceData, UpdatePriceError, UpdatePriceErrors, UpdatePriceResponse, UpdatePriceResponses, UpdateProductData, UpdateProductError, UpdateProductErrors, UpdateProductResponse, UpdateProductResponses, UpdateSetupFlowData, UpdateSetupFlowError, UpdateSetupFlowErrors, UpdateSetupFlowResponse, UpdateSetupFlowResponses, UpdateTaxRateData, UpdateTaxRateError, UpdateTaxRateErrors, UpdateTaxRateResponse, UpdateTaxRateResponses, Usage, attachPaymentMethod, cancelPaymentFlow, cancelSetupFlow, capturePaymentFlow, confirmPaymentFlow, createBalanceUrl, createCheckoutSession, createClient, createCustomer, createPaymentFlow, createPaymentMethod, createPaymentRefund, createPrice, createProduct, createSetupFlow, createStatementUrl, createTaxRate, deleteCustomer, deleteProduct, detachPaymentMethod, getAllBalances, getAllCheckoutSessionLineItems, getAllCheckoutSessions, getAllCustomers, getAllEvents, getAllPaymentFlows, getAllPaymentMethodConfigurations, getAllPaymentMethods, getAllPaymentRefunds, getAllPaymentTransactions, getAllPrices, getAllProducts, getAllSetupFlows, getAllStatements, getAllTaxRates, getAllTerms, getBalance, getCheckoutSession, getCustomer, getCustomerPaymentMethods, getEvent, getPaymentFlow, getPaymentFlowRefunds, getPaymentMethod, getPaymentMethodByCard, getPaymentMethodConfiguration, getPaymentRefund, getPaymentTransaction, getPrice, getProduct, getSetupFlow, getStatement, getTaxRate, getTerm, updateCheckoutSession, updateCustomer, updatePaymentFlow, updatePaymentMethod, updatePaymentMethodConfiguration, updatePaymentRefund, updatePrice, updateProduct, updateSetupFlow, updateTaxRate };
6410
+ export { AttachPaymentMethodData, AttachPaymentMethodError, AttachPaymentMethodErrors, AttachPaymentMethodResponse, AttachPaymentMethodResponses, BalanceListResponse, BalanceResponse, BalanceState, BalanceUrlResponse, BankInfoResponse, CancelPaymentFlowData, CancelPaymentFlowError, CancelPaymentFlowErrors, CancelPaymentFlowResponse, CancelPaymentFlowResponses, CancelSetupFlowData, CancelSetupFlowError, CancelSetupFlowErrors, CancelSetupFlowResponse, CancelSetupFlowResponses, CaptureMethod, CapturePaymentFlowData, CapturePaymentFlowError, CapturePaymentFlowErrors, CapturePaymentFlowResponse, CapturePaymentFlowResponses, CardConfigRequest, CheckoutSessionCreateRequest, CheckoutSessionCustomerDetailsAddressResponse, CheckoutSessionCustomerDetailsResponse, CheckoutSessionDetailsResponse, CheckoutSessionLineItemDataResponse, CheckoutSessionLineItemListResponse, CheckoutSessionListResponse, CheckoutSessionMode, CheckoutSessionPaymentMethodOptionsCardRequest, CheckoutSessionPaymentMethodOptionsRequest, CheckoutSessionStatus, CheckoutSessionSubmitType, CheckoutSessionUiMode, CheckoutSessionUpdateRequest, type Client, type ClientConfig, ClientOptions, ConfirmPaymentFlowData, ConfirmPaymentFlowError, ConfirmPaymentFlowErrors, ConfirmPaymentFlowResponse, ConfirmPaymentFlowResponses, Country, CreateBalanceUrlData, CreateBalanceUrlError, CreateBalanceUrlErrors, CreateBalanceUrlResponse, CreateBalanceUrlResponses, CreateCheckoutSessionData, CreateCheckoutSessionError, CreateCheckoutSessionErrors, CreateCheckoutSessionResponse, CreateCheckoutSessionResponses, CreateCustomerData, CreateCustomerError, CreateCustomerErrors, CreateCustomerResponse, CreateCustomerResponses, CreatePaymentFlowData, CreatePaymentFlowError, CreatePaymentFlowErrors, CreatePaymentFlowResponse, CreatePaymentFlowResponses, CreatePaymentMethodData, CreatePaymentMethodError, CreatePaymentMethodErrors, CreatePaymentMethodResponse, CreatePaymentMethodResponses, CreatePaymentRefundData, CreatePaymentRefundError, CreatePaymentRefundErrors, CreatePaymentRefundResponse, CreatePaymentRefundResponses, CreatePriceData, CreatePriceError, CreatePriceErrors, CreatePriceResponse, CreatePriceResponses, CreateProductData, CreateProductError, CreateProductErrors, CreateProductResponse, CreateProductResponses, CreateSetupFlowData, CreateSetupFlowError, CreateSetupFlowErrors, CreateSetupFlowResponse, CreateSetupFlowResponses, CreateStatementUrlData, CreateStatementUrlError, CreateStatementUrlErrors, CreateStatementUrlResponse, CreateStatementUrlResponses, CreateTaxRateData, CreateTaxRateError, CreateTaxRateErrors, CreateTaxRateResponse, CreateTaxRateResponses, Currency, CustomerCreateRequest, CustomerCreation, CustomerListResponse, CustomerResponse, CustomerUpdateRequest, DeleteCustomerData, DeleteCustomerError, DeleteCustomerErrors, DeleteCustomerResponse, DeleteCustomerResponses, DeleteProductData, DeleteProductError, DeleteProductErrors, DeleteProductResponse, DeleteProductResponses, DetachPaymentMethodData, DetachPaymentMethodError, DetachPaymentMethodErrors, DetachPaymentMethodResponse, DetachPaymentMethodResponses, DisplayPreferenceRequest, ErrorResponse, EventListResponse, EventResponse, GetAllBalancesData, GetAllBalancesError, GetAllBalancesErrors, GetAllBalancesResponse, GetAllBalancesResponses, GetAllCheckoutSessionLineItemsData, GetAllCheckoutSessionLineItemsError, GetAllCheckoutSessionLineItemsErrors, GetAllCheckoutSessionLineItemsResponse, GetAllCheckoutSessionLineItemsResponses, GetAllCheckoutSessionsData, GetAllCheckoutSessionsError, GetAllCheckoutSessionsErrors, GetAllCheckoutSessionsResponse, GetAllCheckoutSessionsResponses, GetAllCustomersData, GetAllCustomersError, GetAllCustomersErrors, GetAllCustomersResponse, GetAllCustomersResponses, GetAllEventsData, GetAllEventsError, GetAllEventsErrors, GetAllEventsResponse, GetAllEventsResponses, GetAllPaymentFlowsData, GetAllPaymentFlowsError, GetAllPaymentFlowsErrors, GetAllPaymentFlowsResponse, GetAllPaymentFlowsResponses, GetAllPaymentMethodConfigurationsData, GetAllPaymentMethodConfigurationsError, GetAllPaymentMethodConfigurationsErrors, GetAllPaymentMethodConfigurationsResponse, GetAllPaymentMethodConfigurationsResponses, GetAllPaymentMethodsData, GetAllPaymentMethodsError, GetAllPaymentMethodsErrors, GetAllPaymentMethodsResponse, GetAllPaymentMethodsResponses, GetAllPaymentRefundsData, GetAllPaymentRefundsError, GetAllPaymentRefundsErrors, GetAllPaymentRefundsResponse, GetAllPaymentRefundsResponses, GetAllPaymentTransactionsData, GetAllPaymentTransactionsError, GetAllPaymentTransactionsErrors, GetAllPaymentTransactionsResponse, GetAllPaymentTransactionsResponses, GetAllPricesData, GetAllPricesError, GetAllPricesErrors, GetAllPricesResponse, GetAllPricesResponses, GetAllProductsData, GetAllProductsError, GetAllProductsErrors, GetAllProductsResponse, GetAllProductsResponses, GetAllSetupFlowsData, GetAllSetupFlowsError, GetAllSetupFlowsErrors, GetAllSetupFlowsResponse, GetAllSetupFlowsResponses, GetAllStatementsData, GetAllStatementsError, GetAllStatementsErrors, GetAllStatementsResponse, GetAllStatementsResponses, GetAllTaxRatesData, GetAllTaxRatesError, GetAllTaxRatesErrors, GetAllTaxRatesResponse, GetAllTaxRatesResponses, GetAllTermsData, GetAllTermsError, GetAllTermsErrors, GetAllTermsResponse, GetAllTermsResponses, GetBalanceData, GetBalanceError, GetBalanceErrors, GetBalanceResponse, GetBalanceResponses, GetCheckoutSessionData, GetCheckoutSessionError, GetCheckoutSessionErrors, GetCheckoutSessionResponse, GetCheckoutSessionResponses, GetCustomerData, GetCustomerError, GetCustomerErrors, GetCustomerPaymentMethodsData, GetCustomerPaymentMethodsError, GetCustomerPaymentMethodsErrors, GetCustomerPaymentMethodsResponse, GetCustomerPaymentMethodsResponses, GetCustomerResponse, GetCustomerResponses, GetEventData, GetEventError, GetEventErrors, GetEventResponse, GetEventResponses, GetPaymentFlowData, GetPaymentFlowError, GetPaymentFlowErrors, GetPaymentFlowRefundsData, GetPaymentFlowRefundsError, GetPaymentFlowRefundsErrors, GetPaymentFlowRefundsResponse, GetPaymentFlowRefundsResponses, GetPaymentFlowResponse, GetPaymentFlowResponses, GetPaymentMethodByCardData, GetPaymentMethodByCardError, GetPaymentMethodByCardErrors, GetPaymentMethodByCardResponse, GetPaymentMethodByCardResponses, GetPaymentMethodConfigurationData, GetPaymentMethodConfigurationError, GetPaymentMethodConfigurationErrors, GetPaymentMethodConfigurationResponse, GetPaymentMethodConfigurationResponses, GetPaymentMethodData, GetPaymentMethodError, GetPaymentMethodErrors, GetPaymentMethodResponse, GetPaymentMethodResponses, GetPaymentRefundData, GetPaymentRefundError, GetPaymentRefundErrors, GetPaymentRefundResponse, GetPaymentRefundResponses, GetPaymentTransactionData, GetPaymentTransactionError, GetPaymentTransactionErrors, GetPaymentTransactionResponse, GetPaymentTransactionResponses, GetPriceData, GetPriceError, GetPriceErrors, GetPriceResponse, GetPriceResponses, GetProductData, GetProductError, GetProductErrors, GetProductResponse, GetProductResponses, GetSetupFlowData, GetSetupFlowError, GetSetupFlowErrors, GetSetupFlowResponse, GetSetupFlowResponses, GetStatementData, GetStatementError, GetStatementErrors, GetStatementResponse, GetStatementResponses, GetTaxRateData, GetTaxRateError, GetTaxRateErrors, GetTaxRateResponse, GetTaxRateResponses, GetTermData, GetTermError, GetTermErrors, GetTermResponse, GetTermResponses, LineItemRequest, Locale, Options, PayPayConfigRequest, PaymentFlowCancelRequest, PaymentFlowCancellationReason, PaymentFlowCaptureRequest, PaymentFlowConfirmRequest, PaymentFlowCreateRequest, PaymentFlowDataRequest, PaymentFlowListResponse, PaymentFlowPaymentMethodOptionsCardRequest, PaymentFlowPaymentMethodOptionsRequest, PaymentFlowResponse, PaymentFlowStatus, PaymentFlowUpdateRequest, PaymentMethodApplePayCreateRequest, PaymentMethodApplePayUpdateRequest, PaymentMethodAttachRequest, PaymentMethodBillingAddressRequest, PaymentMethodBillingAddressResponse, PaymentMethodBillingDetailsRequest, PaymentMethodBillingDetailsResponse, PaymentMethodCardBillingDetailsRequest, PaymentMethodCardCreateRequest, PaymentMethodCardDetailsResponse, PaymentMethodCardResponse, PaymentMethodCardUpdateRequest, PaymentMethodConfigurationDetailsResponse, PaymentMethodConfigurationDisplayPreference, PaymentMethodConfigurationListResponse, PaymentMethodConfigurationSettingResponse, PaymentMethodConfigurationUpdateRequest, PaymentMethodCreateCardDetailsRequest, PaymentMethodCreateRequest, PaymentMethodListResponse, PaymentMethodPayPayCreateRequest, PaymentMethodPayPayResponse, PaymentMethodPayPayUpdateRequest, PaymentMethodResponse, PaymentMethodTypes, PaymentMethodUpdateRequest, PaymentRefundCreateRequest, PaymentRefundListResponse, PaymentRefundReason, PaymentRefundResponse, PaymentRefundStatus, PaymentRefundUpdateRequest, PaymentTransactionListResponse, PaymentTransactionResponse, PaymentTransactionType, PriceCreateRequest, PriceDetailsResponse, PriceListResponse, PriceType, PriceUpdateRequest, ProductCreateRequest, ProductDeletedResponse, ProductDetailsResponse, ProductListResponse, ProductUpdateRequest, SetupFlowCancelRequest, SetupFlowCancellationReason, SetupFlowCreateRequest, SetupFlowDataRequest, SetupFlowListResponse, SetupFlowPaymentMethodOptionsCardRequest, SetupFlowPaymentMethodOptionsRequest, SetupFlowResponse, SetupFlowStatus, SetupFlowUpdateRequest, StatementItemResponse, StatementListResponse, StatementResponse, StatementSubject, StatementType, StatementUrlResponse, TaxRateCreateRequest, TaxRateDetailsResponse, TaxRateListResponse, TaxRateUpdateRequest, TermListResponse, TermResponse, UpdateCheckoutSessionData, UpdateCheckoutSessionError, UpdateCheckoutSessionErrors, UpdateCheckoutSessionResponse, UpdateCheckoutSessionResponses, UpdateCustomerData, UpdateCustomerError, UpdateCustomerErrors, UpdateCustomerResponse, UpdateCustomerResponses, UpdatePaymentFlowData, UpdatePaymentFlowError, UpdatePaymentFlowErrors, UpdatePaymentFlowResponse, UpdatePaymentFlowResponses, UpdatePaymentMethodConfigurationData, UpdatePaymentMethodConfigurationError, UpdatePaymentMethodConfigurationErrors, UpdatePaymentMethodConfigurationResponse, UpdatePaymentMethodConfigurationResponses, UpdatePaymentMethodData, UpdatePaymentMethodError, UpdatePaymentMethodErrors, UpdatePaymentMethodResponse, UpdatePaymentMethodResponses, UpdatePaymentRefundData, UpdatePaymentRefundError, UpdatePaymentRefundErrors, UpdatePaymentRefundResponse, UpdatePaymentRefundResponses, UpdatePriceData, UpdatePriceError, UpdatePriceErrors, UpdatePriceResponse, UpdatePriceResponses, UpdateProductData, UpdateProductError, UpdateProductErrors, UpdateProductResponse, UpdateProductResponses, UpdateSetupFlowData, UpdateSetupFlowError, UpdateSetupFlowErrors, UpdateSetupFlowResponse, UpdateSetupFlowResponses, UpdateTaxRateData, UpdateTaxRateError, UpdateTaxRateErrors, UpdateTaxRateResponse, UpdateTaxRateResponses, Usage, attachPaymentMethod, cancelPaymentFlow, cancelSetupFlow, capturePaymentFlow, confirmPaymentFlow, createBalanceUrl, createCheckoutSession, createClient, createCustomer, createPaymentFlow, createPaymentMethod, createPaymentRefund, createPrice, createProduct, createSetupFlow, createStatementUrl, createTaxRate, deleteCustomer, deleteProduct, detachPaymentMethod, getAllBalances, getAllCheckoutSessionLineItems, getAllCheckoutSessions, getAllCustomers, getAllEvents, getAllPaymentFlows, getAllPaymentMethodConfigurations, getAllPaymentMethods, getAllPaymentRefunds, getAllPaymentTransactions, getAllPrices, getAllProducts, getAllSetupFlows, getAllStatements, getAllTaxRates, getAllTerms, getBalance, getCheckoutSession, getCustomer, getCustomerPaymentMethods, getEvent, getPaymentFlow, getPaymentFlowRefunds, getPaymentMethod, getPaymentMethodByCard, getPaymentMethodConfiguration, getPaymentRefund, getPaymentTransaction, getPrice, getProduct, getSetupFlow, getStatement, getTaxRate, getTerm, updateCheckoutSession, updateCustomer, updatePaymentFlow, updatePaymentMethod, updatePaymentMethodConfiguration, updatePaymentRefund, updatePrice, updateProduct, updateSetupFlow, updateTaxRate };
6276
6411
  //# sourceMappingURL=index.d.mts.map