REST Resource: purchases.subscriptions

{
  "kind": string,
  "startTimeMillis": string,
  "expiryTimeMillis": string,
  "autoResumeTimeMillis": string,
  "autoRenewing": boolean,
  "priceCurrencyCode": string,
  "priceAmountMicros": string,
  "introductoryPriceInfo": {
    object (IntroductoryPriceInfo)
  },
  "countryCode": string,
  "developerPayload": string,
  "paymentState": integer,
  "cancelReason": integer,
  "userCancellationTimeMillis": string,
  "cancelSurveyResult": {
    object (SubscriptionCancelSurveyResult)
  },
  "orderId": string,
  "linkedPurchaseToken": string,
  "purchaseType": integer,
  "priceChange": {
    object (SubscriptionPriceChange)
  },
  "profileName": string,
  "emailAddress": string,
  "givenName": string,
  "familyName": string,
  "profileId": string,
  "acknowledgementState": integer,
  "externalAccountId": string,
  "promotionType": integer,
  "promotionCode": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string
}

string

این نوع نشان دهنده یک شیء اشتراک خرید در سرویس androidpublisher است.

string ( int64 format)

زمانی که در آن اشتراک اعطا شد، بر حسب میلی ثانیه از دوران.

string ( int64 format)

زمانی که در آن اشتراک منقضی می‌شود، بر حسب میلی‌ثانیه از دوران.

string ( int64 format)

زمانی که در آن اشتراک به طور خودکار از سر گرفته می شود، در میلی ثانیه از زمان. فقط در صورتی ارائه شود که کاربر درخواست توقف اشتراک را داشته باشد.

boolean

آیا اشتراک زمانی که به زمان انقضای فعلی خود برسد به طور خودکار تمدید می شود یا خیر.

string

کد ارز ISO 4217 برای قیمت اشتراک. برای مثال، اگر قیمت به پوند استرلینگ بریتانیا مشخص شده باشد، PriceCurrencyCode "GBP" است.

string ( int64 format)

قیمت اشتراک، برای کشورهای بدون مالیات، قیمت شامل مالیات نمی شود. برای کشورهایی که شامل مالیات می شوند، قیمت شامل مالیات می شود. قیمت در واحدهای خرد بیان می شود که در آن 1,000,000 میکرو واحد نشان دهنده یک واحد ارز است. به عنوان مثال، اگر قیمت اشتراک 1.99 یورو باشد، قیمتAmountMicros 1990000 است.

object ( IntroductoryPriceInfo )

اطلاعات قیمت مقدماتی اشتراک. این تنها زمانی وجود دارد که اشتراک با قیمت مقدماتی خریداری شده باشد.

این قسمت نشان نمی دهد که اشتراک در حال حاضر در دوره قیمت اولیه است.

string

کد کشور/منطقه صورت‌حساب ISO 3166-1 آلفا-2 کاربر در زمان اعطای اشتراک.

string

یک رشته مشخص شده توسط توسعه دهنده که حاوی اطلاعات تکمیلی در مورد یک سفارش است.

integer

وضعیت پرداخت اشتراک. مقادیر ممکن عبارتند از: 0. پرداخت در انتظار 1. پرداخت دریافت شده 2. آزمایشی رایگان 3. در انتظار ارتقا/کاهش به تعویق افتاده

برای اشتراک های لغو شده و منقضی شده وجود ندارد.

integer

دلیل لغو یا عدم تمدید اشتراک اشتراک خودکار است. مقادیر ممکن عبارتند از: 0. کاربر اشتراک را لغو کرد 1. اشتراک توسط سیستم لغو شد، برای مثال به دلیل مشکل صورت‌حساب، 2. اشتراک با یک اشتراک جدید جایگزین شد. 3. اشتراک توسط توسعه‌دهنده لغو شد.

string ( int64 format)

زمانی که در آن اشتراک توسط کاربر لغو شد، بر حسب میلی ثانیه از آن دوره. فقط در صورتی ارائه شود که cancelReason 0 باشد.

object ( SubscriptionCancelSurveyResult )

اطلاعات ارائه شده توسط کاربر هنگام تکمیل جریان لغو اشتراک (نظرسنجی دلیل لغو).

string

شناسه سفارش آخرین سفارش تکراری مرتبط با خرید اشتراک. اگر اشتراک به دلیل رد شدن پرداخت لغو شد، این شناسه سفارش از سفارش رد شده پرداخت خواهد بود.

string

نشانه خرید خرید مبدأ در صورتی که این اشتراک یکی از موارد زیر باشد: 0. ثبت نام مجدد اشتراک لغو شده اما بدون پایان 1. ارتقا/کاهش از اشتراک قبلی

به عنوان مثال، فرض کنید یک کاربر در ابتدا ثبت نام کرده است و شما رمز خرید X را دریافت می کنید، سپس کاربر آن را لغو کرده و از جریان ثبت نام (قبل از اتمام اشتراک خود) عبور می کند و شما رمز خرید Y را دریافت می کنید و در نهایت کاربر اشتراک خود را ارتقا می دهد و شما خرید را دریافت می کنید. نشانه Z. اگر این API را با رمز خرید Z فراخوانی کنید، این فیلد روی Y تنظیم می شود. اگر این API را با رمز خرید Y تماس بگیرید، این فیلد روی X تنظیم می شود. اگر این API را با رمز خرید X تماس بگیرید، این فیلد تنظیم نخواهد شد

integer

نوع خرید اشتراک. این فیلد فقط در صورتی تنظیم می‌شود که این خرید با استفاده از جریان استاندارد صورت‌حساب درون برنامه‌ای انجام نشده باشد. مقادیر ممکن عبارتند از: 0. تست (یعنی خریداری شده از یک حساب آزمایشی مجوز) 1. تبلیغاتی (یعنی با استفاده از کد تبلیغاتی خریداری شده است)

object ( SubscriptionPriceChange )

آخرین اطلاعات تغییر قیمت موجود است. این تنها زمانی وجود دارد که تغییر قیمت آتی برای اشتراک هنوز اعمال نشده باشد.

پس از تمدید اشتراک با قیمت جدید یا لغو اشتراک، هیچ اطلاعات تغییر قیمت برگردانده نخواهد شد.

string

نام نمایه کاربر هنگام خرید اشتراک. فقط برای خریدهای انجام شده با "اشتراک با Google" ارائه می شود.

string

آدرس ایمیل کاربر هنگام خرید اشتراک. فقط برای خریدهای انجام شده با "اشتراک با Google" ارائه می شود.

string

نام داده شده کاربر هنگام خرید اشتراک. فقط برای خریدهای انجام شده با "اشتراک با Google" ارائه می شود.

string

نام خانوادگی کاربر هنگام خرید اشتراک. فقط برای خریدهای انجام شده با "اشتراک با Google" ارائه می شود.

string

شناسه نمایه Google کاربر هنگام خرید اشتراک. فقط برای خریدهای انجام شده با "اشتراک با Google" ارائه می شود.

integer

وضعیت تأیید محصول اشتراک. مقادیر ممکن عبارتند از: 0. هنوز باید تایید شود 1. تایید

string

شناسه حساب کاربری در سرویس شخص ثالث. فقط در صورتی ارائه شود که پیوند حساب به عنوان بخشی از جریان خرید اشتراک اتفاق افتاده باشد.

integer

نوع تبلیغات اعمال شده در این خرید. این فیلد تنها در صورتی تنظیم می‌شود که هنگام خرید اشتراک، تبلیغی اعمال شود. مقادیر ممکن عبارتند از: 0. کد یکبار مصرف 1. کد غرور

string

کد تبلیغاتی اعمال شده در این خرید. این فیلد تنها در صورتی تنظیم می‌شود که هنگام خرید اشتراک، یک تبلیغ کد بیهوده اعمال شود.

string

یک نسخه مبهم از شناسه که به طور منحصر به فرد با حساب کاربر در برنامه شما مرتبط است. برای خریدهای زیر ارائه دهید: * اگر پیوند حساب به عنوان بخشی از جریان خرید اشتراک اتفاق افتاده باشد. * هنگام خرید با استفاده از https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid مشخص شد.

string

یک نسخه مبهم از شناسه که به طور منحصر به فرد با نمایه کاربر در برنامه شما مرتبط است. فقط در صورت مشخص شدن با استفاده از https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid هنگام خرید.

{
  "introductoryPriceCurrencyCode": string,
  "introductoryPriceAmountMicros": string,
  "introductoryPricePeriod": string,
  "introductoryPriceCycles": integer
}

string

کد ارز ISO 4217 برای قیمت اشتراک مقدماتی. برای مثال، اگر قیمت به پوند استرلینگ بریتانیا مشخص شده باشد، PriceCurrencyCode "GBP" است.

string ( int64 format)

قیمت اولیه اشتراک بدون احتساب مالیات. واحد پول همان priceCurrencyCode است. قیمت در واحدهای خرد بیان می شود که در آن 1,000,000 میکرو واحد نشان دهنده یک واحد ارز است. به عنوان مثال، اگر قیمت اشتراک 1.99 یورو باشد، قیمتAmountMicros 1990000 است.

string

دوره قیمت اولیه، مشخص شده در قالب ISO 8601. مقادیر رایج عبارتند از (اما نه محدود به) "P1W" (یک هفته)، "P1M" (یک ماه)، "P3M" (سه ماه)، "P6M" (شش ماه)، و "P1Y" (یک سال).

integer

تعداد دوره صورتحساب برای ارائه قیمت اولیه.

{
  "cancelSurveyReason": integer,
  "userInputCancelReason": string
}

integer

دلیل لغوی که کاربر در نظرسنجی انتخاب کرده است. مقادیر ممکن عبارتند از: 0. سایر 1. من به اندازه کافی از این سرویس استفاده نمی کنم 2. مسائل فنی 3. دلایل مربوط به هزینه 4. برنامه بهتری پیدا کردم

string

دلیل لغو ورودی سفارشی شده از کاربر. فقط زمانی ارائه می شود که cancelReason 0 باشد.

{
  "newPrice": {
    object (Price)
  },
  "state": integer
}

object ( Price )

در صورت پذیرش تغییر قیمت توسط کاربر، اشتراک با قیمت جدیدی تمدید خواهد شد.

integer

وضعیت فعلی تغییر قیمت. مقادیر ممکن عبارتند از: 0. برجسته: وضعیت برای تغییر قیمت معلق در انتظار موافقت کاربر. در این حالت، می‌توانید به‌صورت اختیاری با استفاده از API درون‌برنامه، از کاربر تأییدیه بگیرید. 1. Accepted: برای تغییر قیمت پذیرفته شده اعلام کنید که اشتراک با آن تمدید می شود مگر اینکه لغو شود. تغییر قیمت در تاریخ آینده زمانی که اشتراک تمدید می شود، اعمال می شود. توجه داشته باشید که این تغییر ممکن است در زمان تمدید اشتراک بعدی رخ ندهد.