1Password パートナーシップ API リファレンス
1Passwordマニュアル｜顧客のサードパーティーパートナー請求アカウントをAPIで効率的に管理し、プロビジョニングとデプロビジョニングを簡素化します。
1Password パートナーシップ API を使うと、顧客向けのサードパーティ パートナーの請求アカウントのプロビジョニングとデプロビジョニングを管理できます。API は、1Password の個人アカウントとファミリー アカウントのパートナー請求アカウントをサポートしています。パートナーシップ API は、1Password チーム アカウントまたはビジネス アカウントをサポートしていません。
注記
別のツールで 1Password Partnership API を使うには、API 仕様ファイル1password-partnership-api.ymlをダウンロードします。
前提条件
API を使用してパートナーの請求サービスと統合する前に、1Password パートナーとして登録する必要があります。登録されたパートナーには、API 請求サーバーへのリクエストを承認するためのベアラー トークンへのアクセス権が付与されます。
パートナーシップの機会について詳しくは、1Password パートナー プログラムの Web サイトにアクセスするか、1Password パートナーシップ チームにお問い合わせください。
APIに関する情報
1Password パートナーシップ API は、 OpenAPI 3.0 仕様に準拠した REST スタイルの API です。クライアントとサーバー間の全ての通信は HTTPS 経由で行われます。
パートナーシップ API のテストと実装には、お好みのプログラミング言語とツールを使用できます。このリファレンスでは、コマンド ラインでcurl を使用してサンプル リクエストを示します。リクエスト内の値を独自の値に置き換えて、顧客の請求アカウントに関する情報を受け取ることができます。
Request methods
次の標準 HTTP メソッドを使用して、Partnership API にリクエストを送信できます。
POST : パートナーの請求サービスを通じて顧客のサードパーティの請求アカウントをCreateします。
GET : 顧客の請求アカウントの詳細を取得します。
DELETE : パートナーの請求サービスから顧客のサードパーティの請求アカウントを削除します。
パッチ: 顧客の請求アカウントがパートナーの請求サービスから削除される予定の日時を更新します。
バッチリクエストはサポートされていません。
Servers
パートナーが 1Password Partnership API を操Createするために使用できる課金サーバーには、API エンドポイントのベース URL を提供するものが 2 つあります。
Test server( https://billing.b5test.eu): テスト環境内の全てのリクエストのベースとしてテスト サーバーの URL を使用します。テスト サーバー ( b5test.com、b5test.ca、b5test.eu)から、全てのドメインのテスト パートナー課金アカウントをプロビジョニングおよびプロビジョニング解除できます。
Production server( https://billing.1password.com): 運用環境の全てのリクエストのベースとして運用サーバーの URL を使用します。運用サーバーから、全てのドメイン ( 1password.com、1password.ca、および1password.eu ) のパートナー課金アカウントをプロビジョニングおよびプロビジョニング解除できます。
Endpoints
API への各リクエストは、操Createするサーバー環境 (テストまたは本番) のベース URL で始まり、その後にパス ( api/v1/partners/account) が続きます。中括弧 ( {}) で示されるパス パラメータは、定義されている場合に必須です。例:
APIエンドポイントの構造
①<base_URL>/②<path>/③{parameters}
①base_URLと③{parameters}プレースホルダーを、使用しているサーバー環境とリクエストに指定されたパス パラメータに置き換えます。②pathは全てのリクエストで同じです。
パスパラメータのない API エンドポイントの例
①https://billing.b5test.eu/②api/v1/partners/accounts
パスパラメータを持つ API エンドポイントの例
①https://billing.1password.com/②api/v1/partners/accounts/③4266474b-6385-56d4-7b75-648096593064
Authorization
1Password パートナー プログラムに登録すると、パートナーシップ チームから、パートナーシップ API への呼び出しを承認するために必要なベアラー トークンが提供されます。
テスト環境と本番環境で使うトークンが別々に提供されます。Create業している環境で承認されたトークンを必ず使用してください。
いずれかの環境で新しいベアラー トークンが必要な場合は、1Password パートナーシップ チームにお問い合わせください。
リクエストヘッダー
パートナーシップ API へのリクエストでは、次の 3 種類のヘッダーが使用されます。
Authorization: パートナーシップ API への各 GET、POST、DELETE、および PATCH リクエストは、ベアラー トークンを使用して承認される必要があります。
Content-Type: 各 POST および PATCH リクエストには、リクエスト本体のメディア (MIME) タイプを示すヘッダーが必要です。
Accept: Partnership API への各 GET、POST、および PATCH リクエストには、クライアントがサーバーから受け入れることができる応答の種類を示す accept ヘッダーを含める必要があります。
全てのデータは JSON として送受信されるため、ヘッダーでそのことを必ず指定してください。
Authorization: Bearer YOUR_BEARER_TOKEN
Content-type: application/json
Accept: application/json
ベアラートークンをお持ちでない場合、またはinvalid auth tokenAPI へのリクエスト時にエラーが発生した場合は、1Password パートナーシップ チームにお問い合わせください。
リクエストボディ
リクエスト ボディ (リクエスト ペイロードとも呼ばれます) には、サーバー上のリソースをCreate (POST) または更新 (PATCH) するためにクライアントが送信する JSON 形式のデータが含まれます。リクエスト ボディは、次に示すように、1 つ以上のフィールドを含むオブジェクトで構成されます。
顧客の請求先アカウントの一意の識別子 (UID)。UID はパートナーによって提供されます。英数字とハイフンの任意の組み合わせで最大 80 文字まで指定できます。
1Password アカウントの種類。オプションは個人 (I) または家族 (F) です。チーム アカウントとビジネス アカウントはサポートされていません。
顧客が新規または保存済みの 1Password アカウントに使用できるドメイン。テスト サーバーの場合、オプションは b5test.com、b5test.ca、または b5test.eu です。実稼働サーバーの場合、オプションは 1password.com、1password.ca、または 1password.eu です。
顧客の請求アカウントを削除する予定の日時。日付は過去の日付にすることはできません。日付、時刻、およびオプションのタイムゾーンは、ISO 8601 標準に従ってフォーマットします。
GET および DELETE 呼び出しにはリクエスト本体は含まれません。
アクティベーショントークン
アクティベーション トークンは、1Password アカウントをパートナーの請求アカウントにリンクすることで、顧客にサードパーティの請求をプロビジョニングするために使用されます。
パートナーシップ API にPOST callを行って、顧客の新しいパートナー請求アカウントをCreateし、固有のアクティベーション トークンを生Createします。
POST レスポンスで返されたトークンを1Password パートナーシップ引き換えリンクに追加して、顧客のパートナー請求リンクをCreateします。次に、顧客にリンクを提供します。
リンクをクリックすると、顧客はプロモーション ページに移動し、新しい 1Password アカウントをCreateするか、保存済みのアカウントにサインインするように指示されます。顧客の 1Password アカウントの請求は、パートナーの請求アカウントにリンクされます。
顧客向けリンクをCreateする
顧客のパートナー請求リンクをCreateするには、1Password パートナーシップ引き換えリンク (https://start.[1password_domain]/partnership/redeem) を調整して、目的の 1Password ドメインを使用します。次に、アカウント タイプとアクティベーション トークンに必要なパラメーターを含むクエリ文字列を追加します。オプションの言語パラメータを含めることもできます。
1Password アカウントのパートナー請求リンクの構造
https://start.[1password_domain]/partnership/redeem?t={account_type}&c={activation_token}&l={language_code}
プレースホルダー
価値観
必須
[1password_domain]
可能な値は1password.com、、1password.caまたはです1password.eu。
はい
{account_type}
可能な値はindividualまたは ですfamily。
はい
1Password ドメインのプレースホルダーとパラメータを適切な値に置き換えます。例:
オプションの言語パラメータを持つ 1Password.eu の個人アカウントのパートナー請求リンクの例
https://start.1password.eu/partnership/redeem?t=individual&c=4266474b-6385-56d4-7b75-648096593064&l=de
オプションの言語パラメータを持つ 1Password.com のファミリー アカウントのパートナー請求リンクの例
https://start.1password.com/partnership/redeem?t=family&c=4266474b-6385-56d4-7b75-648096593064&l=en
どのリンクをCreateする必要があるかわからない場合は、1Password パートナーシップ チームにお問い合わせください。
注意
保存済みの 1Password アカウントを持つお客様の場合、パートナーの請求リンクは、1Password アカウントの種類とドメインがPOST リクエストで指定されたものと同じである場合にのみ機能します。
保存済みのアカウントの種類や地域を変更する際にサポートが必要な場合は、1Password サポートにお問い合わせください。
Alternate partner billing link options
代替リンク オプションの詳細をご覧ください。
パートナーシップ API は、パートナーの請求リンクの代替オプションもいくつかサポートしています。パートナーシップの詳細に応じて、次のリンクをCreateすることをお勧めします。
これらのリンクのいずれかを顧客に提供した場合、顧客はそれを使用して、パートナーの請求先アカウントをそれぞれ新しいアカウントまたは保存済みのアカウントにリンクすることのみが可能になります。
また、各タイプのリンクを 1 つずつCreateし、顧客に両方を提供して、必要なオプションを選択できるようにすることもできます。ただし、両方のオプションを可能にする単一のリンクをCreateする方が、より良い解決策となる場合があります。
新しい 1Password アカウント
顧客が新しい 1Password アカウントでのみ使用できるパートナー請求リンクをCreateするには、1Password サインアップ リンク ( https://start.[1password_domain]/sign-up/[account_type]) を調整して、希望する 1Password ドメインとアカウント タイプを使用します。次に、必要なアクティベーション トークン パラメータを含むクエリ文字列を追加します。オプションの言語パラメータを含めることもできます。例:
新しい 1Password アカウントのパートナー請求リンクの構造
https://start.[1password_domain]/sign-up/[account_type]?c={activation_token}&l={language_code}
1Password ドメイン、アカウント タイプ、およびパラメータのプレースホルダーを適切な値に置き換えます。例:
オプションの言語パラメータを持つ 1Password.eu の新規個人アカウントのパートナー請求リンクの例
https://start.1password.eu/sign-up/individual?c=4266474b-6385-56d4-7b75-648096593064&l=de
オプションの言語パラメータを含む 1Password.com の新しいファミリー アカウントのパートナー請求リンクの例
https://start.1password.com/sign-up/family?c=4266474b-6385-56d4-7b75-648096593064&l=en
保存済みの 1Password アカウントのみのリンクをCreateします
保存済みの 1Password アカウントでのみ顧客が使用できるパートナー請求リンクをCreateするには、1Password アカウントのサインイン リンク ( https://my.[1password_domain]/partnership/link) を調整して、目的の 1Password ドメインを使用します。次に、必要なアクティベーション トークン パラメータを含むクエリ文字列を追加します。オプションの言語パラメータを含めることもできます。例:
保存済みの 1Password アカウントのパートナー請求リンクの構造
https://my.[1password_domain]/partnership/link?c={activation_token}&l={language_code}
1Password ドメインのプレースホルダーとパラメータを適切な値に置き換えます。例:
オプションの言語パラメータを持つ 1Password.com の保存済みアカウントのパートナー請求リンクの例
https://my.1password.com/partnership/link?c=4266474b-6385-56d4-7b75-648096593064&l=en
このリンクにはアカウントの種類は含まれません。顧客が既に持っている 1Password アカウントにサインインするように指示するためです。
プレースホルダー参照
プレースホルダー
価値観
必須
[1password_domain]
可能な値は1password.com、、1password.caまたは1password.euです。
はい
[account_type]
アカウント タイプは、新しい 1Password アカウントをCreateするためのリンクでのみ使用されます。可能な値はindividualまたはfamily です。
はい
新規アカウントのみ
言語コード
オプションの言語コード パラメータの詳細について説明します。
言語コードは、パートナーの請求リンクに追加できるオプションのパラメータで、顧客をその言語の適切なランディング ページに誘導します。言語パラメータが含まれていない場合、顧客はデフォルトのランディング ページ (英語) に誘導されます。
言語パラメータでは次の言語コードを使用できます。
言語
コード
英語
en
ドイツ語
de
スペイン語
es
フランス語
fr
イタリア語
it
日本語
ja
言語
コード
韓国語
ko
オランダ語
nl
ポルトガル語
pt-BR
ロシア語
ru
簡体字
zh-Hans
繁體中文
zh-Hant
言語
コード
英語
en
ドイツ語
de
スペイン語
es
フランス語
fr
イタリア語
it
日本語
ja
言語
コード
韓国語
ko
オランダ語
nl
ポルトガル語
pt-BR
ロシア語
ru
簡体字
zh-Hans
繁體中文
zh-Hant
請求先
POST <base_URL>/api/v1/partners/accounts
POST 呼び出しは、パートナー請求サービスを通じて顧客の新しいサードパーティ請求アカウントをCreateし、顧客がプロビジョニングを完了するためのパートナー請求リンクをCreateするために使うアクティベーション トークンを返します。
パス
パスパラメータがありません。
ベアラー トークンと必要なリクエスト ヘッダーを含むエンドポイント URL を使用します。次の内容を含むオブジェクトをリクエスト本文として含めます。
顧客のアカウント UID。
適格な 1Password アカウントの種類。
顧客が新規または保存済みの 1Password アカウントに使用できるドメイン。
(オプション) パートナーの請求サービスから顧客のアカウントを削除する日時。この値は過去のものにすることはできません。PATCHリクエストを使用してこのフィールドを更新することもできます。
Example request
curl --request POST \
--url https://billing.1password.com/api/v1/partners/accounts \
--header 'Authorization: Bearer YOUR_BEARER_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"customer_account_uid": "4266474b-6385-56d4-7b75-648096593064",
"account_type": "F",
"domain": "1password.com",
"ends_at": "2024-08-31T13:00:00-05:00"
}'
Request object schema
名前
タイプ
説明
customer_account_uid
必須
string
顧客の請求アカウントの一意の識別子 (UID)。UID は、英数字とハイフンの任意の組み合わせで最大 80 文字まで指定できます。
account_type
必須
string
顧客にプロビジョニングする 1Password アカウントの種類:I個人アカウントまたはFファミリー アカウント。チーム アカウントとビジネス アカウントはサポートされていません。
domain
必須
string
顧客がパートナーの課金サービスで使用できる新規または保存済みの 1Password アカウントのドメイン。テスト サーバーの場合: b5test.com、b5test.ca、またはb5test.eu。実稼働サーバーの場合: 1password.com、1password.ca、または1password.eu。
ends_at
string
顧客の請求アカウントがパートナーの請求サービスから削除される予定の日時。RFC 3339 で定義された形式を使用します。
Create功レスポンス
201応答では、顧客の 1Password アカウントをパートナーの請求アカウントにリンクするために使用される一意のアクティベーション トークンを含む Account オブジェクトが返されます。
Example response
{
"customer_account_uid": "4266474b-6385-56d4-7b75-648096593064",
"account_type": "F",
"activation_token": "PNS-D5A75BT2",
"domain": "1password.com",
"status": "entitled",
"deployed_members": 0,
"created_at": "2023-08-24T04:19:44Z",
"updated_at": "2023-09-15T15:58:22Z",
"ends_at": "2024-08-31T18:00:00Z"
}
Response object schema
名前
タイプ
説明
customer_account_uid
string
顧客の請求アカウントの一意の識別子 (UID)。UID は、英数字とハイフンの任意の組み合わせで最大 80 文字まで指定できます。
account_type
string
顧客用にプロビジョニングした 1Password アカウントの種類:I個人アカウント用またはFファミリー アカウント用。
activation_token
string
顧客の新規または保存済みの 1Password アカウントをパートナーの請求先アカウント (例: ) に接続するリンクをCreateするために使うアクティベーション トークン。https://start.[1password_domain]/partnership/redeem?t=[account_type]&c=[activation_token]&l=[language_code]トークンは 1Password の個人アカウントまたはファミリー アカウントでのみ使用できます。チーム アカウントとビジネス アカウントはサポートされていません。
domain
string
顧客がパートナーの課金サービスで使用できる新規または保存済みの 1Password アカウントのドメイン。テスト サーバーの場合: b5test.com、b5test.ca、またはb5test.eu。実稼働サーバーの場合: 1password.com、1password.ca、または1password.eu。
status
string
プロビジョニングされた顧客請求アカウントのステータス。可能な値は次のいずれかです。
entitledプロビジョニングは開始されましたが、顧客は新規または保存済みの 1Password アカウントでパートナーの請求リンクを使用していません。
provisioned顧客は新規または保存済みの 1Password アカウントでパートナーの請求リンクを使用し、サードパーティの請求アカウントがプロビジョニングされています。
POST リクエストの期待値は entitledです。
deployed_members
integer
1Password アカウントにプロビジョニングされたユーザーの数。POST
リクエストに対して返される予想値は 0です。
updated_at
string
請求先アカウントが最後に更新された日時。ISO 8601 標準を使用します。このフィールドは、アカウントのステータスが変更されたときに更新されます。POST
リクエストに対して返される予想値は、created_atプロパティの値と同じです。
エラー応答
400不正なリクエストで返されました。
Example error
{
"code": 400,
"error": "bad_request",
"description": "Account type B is not supported."
}
Error object schema
パラメータ
タイプ
説明
code
integer
エラーの HTTP 応答コード。
error
string
コードを表す、機械で解析可能な文字列。
description
string
エラーの説明。
403リクエスト本文に認証ヘッダーがない場合、または無効なトークンが指定された場合に返されます。
Example error
{
"code": 403,
"error": "forbidden",
"description": "Invalid auth token."
}
Error object schema
パラメータ
タイプ
説明
code
integer
エラーの HTTP 応答コード。
error
string
コードを表す、機械で解析可能な文字列。
description
string
エラーの説明。
404リソースまたはリソースの依［Save］関係が見つからない場合に返されます。
Example error
{
"code": 404,
"error": "not_found",
"description": "Domain not found."
}
Error object schema
パラメータ
タイプ
説明
code
integer
エラーの HTTP 応答コード。
error
string
コードを表す、機械で解析可能な文字列。
description
string
エラーの説明。
500予期しないエラーが発生した場合に返されます。
Example error
{
"code": 500,
"error": "internal_server_error",
"description": "Internal server error"
}
Error object schema
パラメータ
タイプ
説明
code
integer
エラーの HTTP 応答コード。
error
string
コードを表す、機械で解析可能な文字列。
description
string
エラーの説明。
請求先アカウント情報
GET <base_URL>/api/v1/partners/accounts/{customer_account_uid}
GET 呼び出しは、顧客の請求アカウントに関する情報を取得します。パス パラメータとして顧客のアカウント UID を必ず含めてください。
パスパラメータ
パラメータ
タイプ
説明
customer_account_uid
必須
string
顧客の請求アカウントの一意の ID。
リクエスト
ベアラー トークンと必要なリクエスト ヘッダーを含むエンドポイント URL を使用して、顧客の課金アカウント情報をリクエストします。GET リクエストには本文が含まれていないため、Content-typeヘッダーは使用されません。
Example request
curl --request GET \
--url https://billing.1password.com/api/v1/partners/accounts/{customer_account_uid} \
--header 'Authorization: Bearer YOUR_BEARER_TOKEN' \
--header 'Accept: application/json'
Create功レスポンス
応答200では、顧客のサードパーティの請求アカウントに関する情報を提供する Account オブジェクトが返されます。
Example response
{
"customer_account_uid": "4266474b-6385-56d4-7b75-648096593064",
"account_type": "F",
"activation_token": "PNS-D5A75BT2",
"domain": "1password.com",
"status": "provisioned",
"deployed_members": 1,
"created_at": "2023-08-24T04:19:44Z",
"updated_at": "2023-09-15T15:58:22Z",
"ends_at": "2024-08-31T18:00:00Z"
}
Response object schema
前
タイプ
説明
customer_account_uid
string
顧客の請求アカウントの一意の識別子 (UID)。UID は、英数字とハイフンの任意の組み合わせで最大 80 文字まで指定できます。
account_type
string
顧客用にプロビジョニングした 1Password アカウントの種類:I個人アカウント用またはFファミリー アカウント用。
activation_token
string
顧客の新規または保存済みの 1Password アカウントをパートナーの請求先アカウント (例: ) に接続するリンクをCreateするために使うアクティベーション トークン。https://start.[1password_domain]/partnership/redeem?t=[account_type]&c=[activation_token]&l=[language_code]トークンは 1Password の個人アカウントまたはファミリー アカウントでのみ使用できます。チーム アカウントとビジネス アカウントはサポートされていません。
domain
string
顧客がパートナーの課金サービスで使用できる新規または保存済みの 1Password アカウントのドメイン。テスト サーバーの場合: b5test.com、b5test.ca、またはb5test.eu。実稼働サーバーの場合: 1password.com、1password.ca、または1password.eu。
status
string
プロビジョニングされた顧客請求アカウントのステータス。可能な値は次のいずれかです。
entitledプロビジョニングは開始されましたが、顧客は新規または保存済みの 1Password アカウントでパートナーの請求リンクを使用していません。
provisioned顧客は新規または保存済みの 1Password アカウントでパートナーの請求リンクを使用し、サードパーティの請求アカウントがプロビジョニングされています。
deployed_members
integer
1Password アカウントにプロビジョニングされたユーザーの数。
エラー応答
403認証ヘッダーが欠落しているか、無効なトークンが指定された場合に返されます。
Example error
{
"code": 403,
"error": "forbidden",
"description": "Invalid auth token."
}
Error object schema
パラメータ
タイプ
説明
code
integer
エラーの HTTP 応答コード。
error
string
コードを表す、機械で解析可能な文字列。
description
string
エラーの説明。
404リソースまたはリソースの依［Save］関係が見つからない場合に返されます。
Example error
{
"code": 404,
"error": "not_found",
"description": "Failed to find the requested account."
}
Error object schema
パラメータ
タイプ
説明
code
integer
エラーの HTTP 応答コード。
error
string
コードを表す、機械で解析可能な文字列。
description
string
エラーの説明。
410リソースが削除されたときに返されます。
Example error
{
"code": 410,
"error": "gone",
"description": "The requested account is gone."
}
Error object schema
パラメータ
タイプ
説明
code
integer
エラーの HTTP 応答コード。
error
string
コードを表す、機械で解析可能な文字列。
description
string
エラーの説明。
500予期しないエラーが発生した場合に返されます。
Example error
{
"code": 500,
"error": "internal_server_error",
"description": "Internal server error"
}
Error object schema
パラメータ
タイプ
説明
code
integer
エラーの HTTP 応答コード。
error
string
コードを表す、機械で解析可能な文字列。
description
string
エラーの説明。
請求先アカウントを削除
DELETE <base_URL>/api/v1/partners/accounts/{customer_account_uid}
DELETE 呼び出しは、パートナーの課金サービスから顧客のサードパーティ課金アカウントを削除します。パス パラメータとして顧客のアカウント UID を必ず含めてください。
パスパラメータ
パラメータ
タイプ
説明
customer_account_uid
必須
string
削除する顧客請求アカウントの一意の ID。
リクエスト
顧客の請求先アカウントを削除するには、必要なリクエスト ヘッダーにベアラー トークンを含むエンドポイント URL を使用します。DELETE リクエストとそれに続く応答には本文が含まれていないため、Content-typeおよびAcceptヘッダーは使用されません。
Example request
curl --request DELETE \
--url https://billing.1password.com/api/v1/partners/accounts/{customer_account_uid} \
--header 'Authorization: Bearer YOUR_BEARER_TOKEN' \
Create功レスポンス
顧客請求アカウントの非アクティブ化と削除が正常に完了すると、204応答が返されます。請求アカウントが削除されたため、GET 要求では顧客アカウント UID のアカウント情報は返されなくなります。
エラー応答
403認証ヘッダーが欠落しているか、無効なトークンが指定された場合に返されます。
Example error
{
"code": 403,
"error": "forbidden",
"description": "Invalid auth token."
}
Error object schema
パラメータ
タイプ
説明
code
integer
エラーの HTTP 応答コード。
error
string
コードを表す、機械で解析可能な文字列。
description
string
エラーの説明。
404リソースまたはリソースの依［Save］関係が見つからない場合に返されます。
Example value
{
"code": 404,
"error": "not_found",
"description": "Failed to find the requested account."
}
Error object schema
パラメータ
タイプ
説明
code
integer
エラーの HTTP 応答コード。
error
string
コードを表す、機械で解析可能な文字列。
description
string
エラーの説明。
500予期しないエラーが発生した場合に返されます。
Example error
{
"code": 500,
"error": "internal_server_error",
"description": "Internal server error"
}
Error object schema
パラメータ
タイプ
説明
code
integer
エラーの HTTP 応答コード。
error
string
コードを表す、機械で解析可能な文字列。
description
string
エラーの説明。
請求先アカウントの終了日
PATCH <base_URL>/api/v1/partners/accounts/{customer_account_uid}
PATCH 呼び出しを使うと、顧客の請求先アカウントの終了日を追加、編集、または削除できます。パス パラメータとして顧客のアカウント UID を必ず含めてください。
パスパラメータ
パラメータ
タイプ
説明
customer_account_uid
必須
string
顧客の請求アカウントの一意の ID。
リクエスト
ベアラー トークンと必要なリクエスト ヘッダーを含むエンドポイント URL を使用します。フィールドを含むオブジェクトをリクエスト ボディends_atとして含めます。
顧客の請求アカウントをパートナーシップ請求サービスから削除する予定の日時を追加または更新するには、RFC 3339 で定義された形式で、新しい日時をends_at値として含めます。
顧客の請求先アカウントから終了日時を削除するには、値として空の文字列 ( "") またはnullを使用します。
Example request
curl --request PATCH \
--url https://billing.1password.com/api/v1/partners/accounts/{customer_account_uid} \
--header 'Authorization: Bearer YOUR_BEARER_TOKEN' \
--header 'Accept: application/json' \
--data '{
"ends_at": "2024-08-31T13:00:00-05:00"
}'
Request object schema
名前
タイプ
説明
ends_at
必須
string
顧客の課金アカウントがパートナー課金サービスから削除される予定の日時。RFC 3339 で定義された形式を使用します。アカウントから終了日を削除する場合は、値として空の文字列 ( "") またはnullを使用します。
Create功レスポンス
応答200では、請求アカウントに追加、編集、または削除された終了日など、顧客のサードパーティ請求アカウントに関する情報を提供する Account オブジェクトが返されます。
Example response
{
"customer_account_uid": "4266474b-6385-56d4-7b75-648096593064",
"account_type": "F",
"activation_token": "PNS-D5A75BT2",
"domain": "1password.com",
"status": "provisioned",
"deployed_members": 1,
"created_at": "2023-08-24T04:19:44Z",
"updated_at": "2023-09-15T15:58:22Z",
"ends_at": "2024-08-31T18:00:00Z"
}
Response object schema
名前
タイプ
説明
customer_account_uid
string
顧客の請求アカウントの一意の識別子 (UID)。UID は、英数字とハイフンの任意の組み合わせで最大 80 文字まで指定できます。
account_type
string
顧客用にプロビジョニングした 1Password アカウントの種類:I個人アカウント用またはFファミリー アカウント用。
activation_token
string
顧客の新規または保存済みの 1Password アカウントをパートナーの請求先アカウント (例: ) に接続するリンクをCreateするために使うアクティベーション トークン。https://start.[1password_domain]/partnership/redeem?t=[account_type]&c=[activation_token]&l=[language_code]トークンは 1Password の個人アカウントまたはファミリー アカウントでのみ使用できます。チーム アカウントとビジネス アカウントはサポートされていません。
domain
string
顧客がパートナーの課金サービスで使用できる新規または保存済みの 1Password アカウントのドメイン。テスト サーバーの場合: b5test.com、b5test.ca、またはb5test.eu。実稼働サーバーの場合: 1password.com、1password.ca、または1password.eu。
status
string
顧客の請求アカウントのステータス。可能な値は次のいずれかです。
entitledプロビジョニングは開始されましたが、顧客は新規または保存済みの 1Password アカウントでパートナーの請求リンクを使用していません。
provisioned顧客は新規または保存済みの 1Password アカウントでパートナーの請求リンクを使用し、サードパーティの請求アカウントがプロビジョニングされています。
deployed_members
integer
1Password アカウントにプロビジョニングされたユーザーの数。
エラー応答
403認証ヘッダーが欠落しているか、無効なトークンが指定された場合に返されます。
Example error
{
"code": 403,
"error": "forbidden",
"description": "Invalid auth token."
}
Error object schema
パラメータ
タイプ
説明
code
integer
エラーの HTTP 応答コード。
error
string
コードを表す、機械で解析可能な文字列。
description
string
エラーの説明。
404リソースまたはリソースの依［Save］関係が見つからない場合に返されます。
Example error
{
"code": 404,
"error": "not_found",
"description": "Failed to find the requested account."
}
Error object schema
パラメータ
タイプ
説明
code
integer
エラーの HTTP 応答コード。
error
string
コードを表す、機械で解析可能な文字列。
description
string
エラーの説明。
410リソースが削除されたときに返されます。
Example error
{
"code": 410,
"error": "gone",
"description": "The requested account is gone."
}
Error object schema
パラメータ
タイプ
説明
code
integer
エラーの HTTP 応答コード。
error
string
コードを表す、機械で解析可能な文字列。
description
string
エラーの説明。
500予期しないエラーが発生した場合に返されます。
Example error
{
"code": 500,
"error": "internal_server_error",
"description": "Internal server error"
}
Error object schema
パラメータ
タイプ
説明
code
integer
エラーの HTTP 応答コード。
error
string
コードを表す、機械で解析可能な文字列。
description
string
エラーの説明。
Last updated