POST /api/v2/server-side-api/purchase/profile/revoke/access-level/

アクセスレベルの取り消し

Copy as Markdown

Adapty内のアプリのエンドユーザーからアクセスレベルを削除します。

Header parameters

adapty-customer-user-idstring

お客様のシステムにおける顧客の一意のIDです。adapty-customer-user-id または adapty-profile-id のいずれかが必須です。

adapty-profile-idstring

お客様のシステムにおけるプロファイルの一意のIDです。匿名プロファイルを扱う場合に最適な選択肢です。adapty-customer-user-id または adapty-profile-id のいずれかが必須です。

Request body

access_level_idstringrequired

アクセスレベルページで設定されたアクセスレベルID

revoke_atstring

アクセスレベルの有効期限を指定します。即座にアクセスを取り消す場合は、このフィールドを省略するか、null に設定してください。デフォルト値は null です。

Responses

アクセスレベルが正常に取り消されました

Schema

dataobjectrequired

app_idstringrequired

アプリの内部ID

profile_idstringrequired

AdaptyのプロファイルID

customer_user_idstringrequired

お客様のシステムにおけるユーザーのID

total_revenue_usdnumberrequired

プロファイルで獲得した総収益（USD）を表すfloat値

segment_hashstringrequired

内部パラメーター

timestampintegerrequired

レスポンス時間（ミリ秒）。競合状態の解決に使用します

custom_attributesarray of objectrequired

プロファイルに設定できるカスタム属性は最大30件です

keystringrequired

キーは30文字以下の文字列である必要があります。使用できるのは英字、数字、ダッシュ、ピリオド、アンダースコアのみです

valuestring | numberrequired

属性値は50文字以下である必要があります。値として使用できるのは文字列と浮動小数点数のみです

access_levelsarray of objectrequired

アクセスレベルオブジェクトの配列。顧客がアクセスレベルを持っていない場合は空の配列

access_level_idstring

アクセスレベルの識別子

storestring

アクセスレベルが購入されたストア

store_product_idstring

ストア内のプロダクトID。App Storeの12ヶ月コミットメントプランの場合、IDの末尾は:monthlyになります。

store_base_plan_idstring

ストア内のベースプランID

store_transaction_idstring

ストア内のトランザクションID

store_original_transaction_idstring

ストア内の元のトランザクションID

offerallOf

プロモーションオファーまたは初回オファーが適用された場合のオファー詳細

categorystring

オファーカテゴリー

One of: "introductory", "promotional", "offer_code", "win_back"

typestring

オファータイプ

One of: "free_trial", "pay_as_you_go", "pay_up_front"

idstring

オファーID

starts_atstring

アクセスレベルの開始日時

purchased_atstring

アクセスレベルが購入された日時

originally_purchased_atstring

アクセスレベルが最初に購入された日時

expires_atstring

アクセスレベルの有効期限

renewal_cancelled_atstring

更新がキャンセルされた日時

billing_issue_detected_atstring

請求の問題が検出された日時

is_in_grace_periodboolean

アクセスレベルがグレース期間中かどうか

cancellation_reasonstring

キャンセルの理由

subscriptionsarray of objectrequired

サブスクリプションオブジェクトの配列。顧客がサブスクリプションを持っていない場合は空の配列

storestring

サブスクリプションが購入されたストア

store_product_idstring

ストアのプロダクトID。App Store の12ヶ月コミットメントプランの場合、IDの末尾は :monthly になります。

store_base_plan_idstring

ストアのベースプランID

store_transaction_idstring

ストアのトランザクションID

store_original_transaction_idstring

ストアの元のトランザクションID

offerallOf

プロモーションオファーまたは初回オファーが適用された場合のオファー詳細

categorystring

オファーカテゴリー

One of: "introductory", "promotional", "offer_code", "win_back"

typestring

オファータイプ

One of: "free_trial", "pay_as_you_go", "pay_up_front"

idstring

オファーID

environmentstring

環境（サンドボックス、本番）

purchased_atstring

サブスクリプションが購入された日時

originally_purchased_atstring

サブスクリプションが最初に購入された日時

expires_atstring

サブスクリプションの有効期限

renewal_cancelled_atstring

更新がキャンセルされた日時。12ヶ月コミットメントプランの場合、サブスクライバーがキャンセルしても月次支払いが継続されるため、null のままとなります。代わりに commitment.will_renew を使用してください。

billing_issue_detected_atstring

請求の問題が検出された日時

is_in_grace_periodboolean

サブスクリプションがグレース期間中かどうか

cancellation_reasonstring

キャンセルの理由

commitmentallOf

App Store コミットメントプランの12ヶ月コミットメント。他のサブスクリプションには設定されません。

will_renewboolean

この契約が終了した後に新しい12ヶ月の契約が開始されるかどうか。サブスクライバーがキャンセルした後は false となり、expires_at まで月次支払いが継続されます。

billing_period_numberinteger

契約における現在の月次支払いの番号（1から開始）

total_billing_periodsinteger

契約における月次支払いの合計数

expires_atstring

契約が終了する日時。サブスクリプション自体の expires_at は現在の支払済み月の終了日です。

non_subscriptionsarray of objectrequired

買い切り購入オブジェクトの配列。顧客が購入履歴を持っていない場合は空の配列

purchase_idstring

購入の一意識別子

storestring

購入が行われたストア

store_product_idstring

ストア内のプロダクトID

store_base_plan_idstring

ストア内のベースプランID

store_transaction_idstring

ストア内のトランザクションID

store_original_transaction_idstring

ストア内の元のトランザクションID

purchased_atstring

購入が行われた日時

environmentstring

環境（サンドボックス、本番）

is_refundboolean

返金かどうか

is_consumableboolean

消耗型アイテムの購入かどうか

リクエストが不正です

Schema

errorsarray of objectrequired

sourcestring

エラーの発生源

errorsarray of string

エラーメッセージの配列

error_codestringrequired

エラーの短い名称

status_codeintegerrequired

HTTPステータスコード

認証されていません

Schema

errorsarray of objectrequired

sourcestring

エラーの発生源

errorsarray of string

エラーメッセージの配列

error_codestringrequired

エラーの短い名称

status_codeintegerrequired

HTTPステータスコード

プロファイルが見つかりません

Schema

errorsarray of objectrequired

sourcestring

エラーの発生源

errorsarray of string

エラーメッセージの配列

error_codestringrequired

エラーの短い名称

status_codeintegerrequired

HTTPステータスコード

内部サーバーエラー

Try it

Authorization

Header parameters

adapty-customer-user-id

adapty-profile-id

Body

curl --request POST \
  --url 'https://api.adapty.io/api/v2/server-side-api/purchase/profile/revoke/access-level/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "access_level_id": "premium"
  }'

const response = await fetch('https://api.adapty.io/api/v2/server-side-api/purchase/profile/revoke/access-level/', {
  method: 'POST',
  headers: {
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "access_level_id": "premium"
  }),
});
const data = await response.json();

import requests

response = requests.post('https://api.adapty.io/api/v2/server-side-api/purchase/profile/revoke/access-level/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
}, json={
      "access_level_id": "premium"
    })
data = response.json()