REST Resource: subscriptions

সম্পদ: সাবস্ক্রিপশন

সাবস্ক্রিপশনের জন্য JSON টেমপ্লেট।

JSON প্রতিনিধিত্ব
{
  "customerId": string,
  "subscriptionId": string,
  "skuId": string,
  "creationTime": string,
  "kind": string,
  "seats": {
    object (Seats)
  },
  "renewalSettings": {
    object (RenewalSettings)
  },
  "purchaseOrderId": string,
  "status": string,
  "resourceUiUrl": string,
  "billingMethod": string,
  "suspensionReasons": [
    string
  ],
  "customerDomain": string,
  "dealCode": string,
  "skuName": string,
  "plan": {
    "planName": string,
    "isCommitmentPlan": boolean,
    "commitmentInterval": {
      "startTime": string,
      "endTime": string
    }
  },
  "trialSettings": {
    "isInTrial": boolean,
    "trialEndTime": string
  },
  "transferInfo": {
    "transferabilityExpirationTime": string,
    "minimumTransferableSeats": integer,
    "currentLegacySkuId": string
  }
}
ক্ষেত্র
customerId

string

এই সম্পত্তি সর্বদা একটি প্রতিক্রিয়া হিসাবে Google দ্বারা উত্পন্ন অনন্য শনাক্তকারী হিসাবে ফেরত দেওয়া হবে। একটি অনুরোধে, এই সম্পত্তিটি হয় প্রাথমিক ডোমেন হতে পারে বা Google দ্বারা তৈরি করা অনন্য শনাক্তকারী হতে পারে৷

subscriptionId

string

subscriptionId হল সাবস্ক্রিপশন শনাক্তকারী এবং প্রতিটি গ্রাহকের জন্য অনন্য। এটি একটি প্রয়োজনীয় সম্পত্তি। যেহেতু একটি সাবস্ক্রিপশন আপডেট করা হলে একটি subscriptionId পরিবর্তিত হয়, তাই আমরা এই আইডিটিকে স্থায়ী ডেটার জন্য একটি কী হিসাবে ব্যবহার না করার পরামর্শ দিই। সমস্ত রিসেলার সদস্যতা পুনরুদ্ধারে বর্ণিত subscriptionId ব্যবহার করুন।

skuId

string

একটি প্রয়োজনীয় সম্পত্তি। skuId হল সাবস্ক্রিপশনে একজন গ্রাহককে বরাদ্দ করা পণ্যের SKU-এর জন্য একটি অনন্য সিস্টেম শনাক্তকারী। API-এর এই সংস্করণে উপলব্ধ পণ্য এবং SKUগুলির জন্য, পণ্য এবং SKU আইডিগুলি দেখুন।

creationTime

string ( int64 format)

creationTime প্রপার্টি হল সেই তারিখ যখন সাবস্ক্রিপশন তৈরি করা হয়েছিল। এটি Epoch ফর্ম্যাট ব্যবহার করে মিলিসেকেন্ডে। একটি উদাহরণ Epoch রূপান্তরকারী দেখুন.

kind

string

সাবস্ক্রিপশন হিসাবে সম্পদ সনাক্ত করে। মান: reseller#subscription

seats

object ( Seats )

এটি একটি প্রয়োজনীয় সম্পত্তি। প্ল্যানে ব্যবহারকারী আসনের লাইসেন্সের সংখ্যা এবং সীমা।

renewalSettings

object ( RenewalSettings )

বার্ষিক প্রতিশ্রুতি পরিকল্পনার জন্য পুনর্নবীকরণ সেটিংস। আরও বিশদ তথ্যের জন্য, প্রশাসক সহায়তা কেন্দ্রে পুনর্নবীকরণ বিকল্পগুলি দেখুন৷

purchaseOrderId

string

এটি একটি ঐচ্ছিক সম্পত্তি। এই ক্রয় আদেশ (PO) তথ্য রিসেলারদের জন্য তাদের কোম্পানির ট্র্যাকিং ব্যবহারের জন্য ব্যবহার করার জন্য। যদি একটি purchaseOrderId মান দেওয়া হয় তবে এটি API প্রতিক্রিয়াগুলিতে প্রদর্শিত হয় এবং চালানে প্রদর্শিত হয়। সম্পত্তি 80টি প্লেইন টেক্সট অক্ষর পর্যন্ত গ্রহণ করে।

status

string

এটি একটি ঐচ্ছিক সম্পত্তি।

resourceUiUrl

string

অ্যাডমিন কনসোলে গ্রাহকের সদস্যতা পৃষ্ঠার URL। শুধুমাত্র পঠনযোগ্য URL API পরিষেবা দ্বারা তৈরি করা হয়। এটি ব্যবহার করা হয় যদি আপনার ক্লায়েন্ট অ্যাপ্লিকেশনের জন্য গ্রাহককে অ্যাডমিন কনসোলে সাবস্ক্রিপশন পৃষ্ঠা ব্যবহার করে একটি কাজ সম্পূর্ণ করার প্রয়োজন হয়।

billingMethod

string

শুধুমাত্র পঠনযোগ্য ক্ষেত্র যা একটি সদস্যতার জন্য বর্তমান বিলিং পদ্ধতি প্রদান করে।

suspensionReasons[]

string

একটি সাবস্ক্রিপশনের জন্য সমস্ত বর্তমান স্থগিতাদেশের কারণগুলির একটি গণনাযোগ্য ধারণ করে শুধুমাত্র পঠনযোগ্য ক্ষেত্র৷ একটি সাবস্ক্রিপশনের জন্য অনেক সমসাময়িক, ওভারল্যাপিং সাসপেনশন কারণ থাকতে পারে। সমস্ত মুলতুবি থাকা সাসপেনশনগুলি সরানো না হওয়া পর্যন্ত একটি সদস্যতার STATUS SUSPENDED করা হয়৷

সম্ভাব্য বিকল্প অন্তর্ভুক্ত:

  • PENDING_TOS_ACCEPTANCE - গ্রাহক লগ ইন করেনি এবং G Suite পুনঃবিক্রীত পরিষেবার শর্তাবলী স্বীকার করেনি৷
  • RENEWAL_WITH_TYPE_CANCEL - গ্রাহকের প্রতিশ্রুতি শেষ হয়েছে এবং তাদের পরিষেবা তাদের মেয়াদ শেষে বাতিল করা হয়েছে৷
  • RESELLER_INITIATED - একটি রিসেলার দ্বারা আহ্বান করা একটি ম্যানুয়াল সাসপেনশন৷
  • TRIAL_ENDED - নির্বাচিত প্ল্যান ছাড়াই গ্রাহকের ট্রায়ালের মেয়াদ শেষ হয়েছে৷
  • OTHER - একটি অভ্যন্তরীণ Google কারণে (যেমন অপব্যবহার বা অন্যথায়) গ্রাহককে সাসপেন্ড করা হয়েছে৷

customerDomain

string

গ্রাহকের প্রাথমিক ডোমেইন নাম

dealCode

string

সাবস্ক্রিপশন প্ল্যানে মূল্য ছাড়ের জন্য Google-এর জারি করা কোড (100 char সর্বোচ্চ)। ডিল কোড ডিসকাউন্ট রেট পেতে insert অনুরোধ অন্তর্ভুক্ত করা আবশ্যক. এই সম্পত্তিটি ঐচ্ছিক, খালি থাকলে নিয়মিত মূল্য প্রযোজ্য।

skuName

string

সাবস্ক্রিপশনে একজন গ্রাহককে বরাদ্দ করা পণ্যের SKU-এর জন্য শুধুমাত্র পঠনযোগ্য বাহ্যিক প্রদর্শন নাম। SKU নামগুলি Google-এর বিবেচনার ভিত্তিতে পরিবর্তিত হতে পারে৷ API-এর এই সংস্করণে উপলব্ধ পণ্য এবং SKUগুলির জন্য, পণ্য এবং SKU আইডিগুলি দেখুন।

plan

object

plan সম্পত্তি প্রয়োজন. API-এর এই সংস্করণে, G Suite প্ল্যানগুলি হল নমনীয় পরিকল্পনা, বার্ষিক প্রতিশ্রুতি পরিকল্পনা এবং 30-দিনের বিনামূল্যের ট্রায়াল প্ল্যান৷ API-এর অর্থপ্রদান পরিকল্পনা সম্পর্কে আরও তথ্যের জন্য, API ধারণাগুলি দেখুন।

plan.planName

string

planName সম্পত্তি প্রয়োজন. এটি সাবস্ক্রিপশনের পরিকল্পনার নাম। Google পেমেন্ট প্ল্যান সম্পর্কে আরও তথ্যের জন্য, API ধারণাগুলি দেখুন।

সম্ভাব্য মান হল:

  • ANNUAL_MONTHLY_PAY — মাসিক পেমেন্ট সহ বার্ষিক প্রতিশ্রুতি পরিকল্পনা।
  • ANNUAL_YEARLY_PAY — বার্ষিক অর্থপ্রদান সহ বার্ষিক প্রতিশ্রুতি পরিকল্পনা
  • FLEXIBLE - নমনীয় পরিকল্পনা
  • TRIAL - 30 দিনের বিনামূল্যের ট্রায়াল প্ল্যান৷ ট্রায়ালে একটি সাবস্ক্রিপশন 30 তম বিনামূল্যে দিনের পরে স্থগিত করা হবে যদি কোনো অর্থপ্রদানের পরিকল্পনা বরাদ্দ না করা হয়। changePlan কল করা একটি ট্রায়ালের জন্য একটি পেমেন্ট প্ল্যান বরাদ্দ করবে কিন্তু প্ল্যানটি সক্রিয় করবে না। একটি ট্রায়াল স্বয়ংক্রিয়ভাবে তার নির্ধারিত পেমেন্ট প্ল্যানটি তার 30তম বিনামূল্যের দিন বা startPaidService কল করার সাথে সাথেই শুরু হবে৷
  • FREE — বিনামূল্যের প্ল্যানটি ক্লাউড আইডেন্টিটি SKU-এর জন্য একচেটিয়া এবং এতে কোনো বিলিং লাগে না।

plan.isCommitmentPlan

boolean

isCommitmentPlan সম্পত্তির বুলিয়ান মান পরিকল্পনাটিকে একটি বার্ষিক প্রতিশ্রুতি পরিকল্পনা হিসাবে চিহ্নিত করে:

  • true — সাবস্ক্রিপশনের পরিকল্পনা হল একটি বার্ষিক প্রতিশ্রুতিবদ্ধ পরিকল্পনা।
  • false — পরিকল্পনাটি একটি বার্ষিক প্রতিশ্রুতি পরিকল্পনা নয়।

plan.commitmentInterval

object

API-এর এই সংস্করণে, বার্ষিক প্রতিশ্রুতি পরিকল্পনার ব্যবধান এক বছর।

plan.commitmentInterval.startTime

string ( int64 format)

UNIX Epoch ফর্ম্যাট ব্যবহার করে মিলিসেকেন্ডে একটি বার্ষিক প্রতিশ্রুতি পরিকল্পনার ব্যবধানের startTime সময়। একটি উদাহরণ Epoch রূপান্তরকারী দেখুন.

plan.commitmentInterval.endTime

string ( int64 format)

UNIX endTime ফর্ম্যাট ব্যবহার করে মিলিসেকেন্ডে একটি বার্ষিক প্রতিশ্রুতি পরিকল্পনার ব্যবধানের শেষ সময়। একটি উদাহরণ Epoch রূপান্তরকারী দেখুন.

trialSettings

object

G Suite বার্ষিক প্রতিশ্রুতি এবং নমনীয় অর্থপ্রদানের পরিকল্পনা 30 দিনের বিনামূল্যের ট্রায়ালে হতে পারে। আরও তথ্যের জন্য, API ধারণাগুলি দেখুন।

trialSettings.isInTrial

boolean

সাবস্ক্রিপশনের প্ল্যান 30-দিনের ফ্রি ট্রায়ালে আছে কিনা তা নির্ধারণ করে:

  • true — পরিকল্পনাটি বিচারাধীন।
  • false — পরিকল্পনাটি বিচারাধীন নয়।

trialSettings.trialEndTime

string ( int64 format)

ট্রায়াল শেষ হওয়ার তারিখ। UNIX Epoch ফর্ম্যাট ব্যবহার করে মানটি মিলিসেকেন্ডে। একটি উদাহরণ Epoch রূপান্তরকারী দেখুন.

transferInfo

object

সাবস্ক্রিপশনের জন্য শুধুমাত্র-পঠন সংক্রান্ত তথ্য স্থানান্তর। আরও তথ্যের জন্য, একটি গ্রাহকের জন্য হস্তান্তরযোগ্য সদস্যতা পুনরুদ্ধার দেখুন।

transferInfo.transferabilityExpirationTime

string ( int64 format)

স্থানান্তর টোকেন বা স্থানান্তর করার অভিপ্রায়ের মেয়াদ শেষ হয়ে যাবে। UNIX Epoch ফরম্যাট ব্যবহার করে সময় মিলিসেকেন্ডে।

transferInfo.minimumTransferableSeats

integer

একটি সাবস্ক্রিপশন সন্নিবেশ করার সময়, এটি এই পণ্যের স্থানান্তর আদেশে তালিকাভুক্ত আসনের ন্যূনতম সংখ্যা। উদাহরণস্বরূপ, যদি গ্রাহকের 20 জন ব্যবহারকারী থাকে, তাহলে রিসেলার 15 আসনের স্থানান্তর আদেশ দিতে পারবে না। ন্যূনতম 20টি আসন।

transferInfo.currentLegacySkuId

string

বর্তমান পুনঃবিক্রীত সদস্যতার skuId । এটি শুধুমাত্র তখনই পূরণ করা হয় যখন গ্রাহকের একটি উত্তরাধিকার SKU সহ সদস্যতা থাকে এবং সদস্যতা সংস্থান স্থানান্তরের জন্য প্রস্তাবিত skuId এর skuId দ্বারা পপুলেট করা হয়।

আসন

সদস্যতা আসনের জন্য JSON টেমপ্লেট।

JSON প্রতিনিধিত্ব
{
  "numberOfSeats": integer,
  "maximumNumberOfSeats": integer,
  "licensedNumberOfSeats": integer,
  "kind": string
}
ক্ষেত্র
numberOfSeats

integer

এটি একটি প্রয়োজনীয় সম্পত্তি এবং এটি ANNUAL_MONTHLY_PAY এবং ANNUAL_YEARLY_PAY প্ল্যান সহ সদস্যতাগুলির জন্য একচেটিয়া৷ এই বৈশিষ্ট্যটি সাবস্ক্রিপশনে ব্যবহারকারীদের জন্য নির্ধারিত সর্বাধিক সংখ্যক লাইসেন্স সেট করে। রিসেলার আরও লাইসেন্স যোগ করতে পারে, কিন্তু একবার সেট হয়ে গেলে, নবায়ন না হওয়া পর্যন্ত numberOfSeats কমানো যাবে না। এই ব্যবহারকারীর লাইসেন্সগুলির কতগুলি বরাদ্দ করা হোক না কেন, numberOfSeats মানের উপর ভিত্তি করে রিসেলারকে চালান করা হয়৷

maximumNumberOfSeats

integer

এটি একটি প্রয়োজনীয় সম্পত্তি এবং FLEXIBLE বা TRIAL প্ল্যান সহ সাবস্ক্রিপশনের জন্য একচেটিয়া। এই বৈশিষ্ট্যটি একটি সাবস্ক্রিপশনে অনুমোদিত লাইসেন্সকৃত ব্যবহারকারীদের সর্বাধিক সংখ্যা সেট করে। এই পরিমাণ রিসেলারের চুক্তিতে নির্ধারিত সর্বোচ্চ সীমা পর্যন্ত বাড়ানো যেতে পারে। সর্বনিম্ন পরিমাণ হল গ্রাহক অ্যাকাউন্টে বর্তমান ব্যবহারকারীর সংখ্যা।

licensedNumberOfSeats

integer

skuId এ সংজ্ঞায়িত পণ্যের জন্য লাইসেন্স বরাদ্দ করা ব্যবহারকারীদের বর্তমান সংখ্যা ধারণকারী শুধুমাত্র-পঠন ক্ষেত্র। এই ক্ষেত্রের মান এন্টারপ্রাইজ লাইসেন্স ম্যানেজার API পদ্ধতি দ্বারা প্রত্যাবর্তিত ব্যবহারকারীদের সংখ্যাগত গণনার সমতুল্য: listForProductAndSku ।

kind

string

সাবস্ক্রিপশন সিট সেটিং হিসাবে সংস্থানটিকে চিহ্নিত করে। মান: subscriptions#seats

পুনর্নবীকরণ সেটিংস

সাবস্ক্রিপশন পুনর্নবীকরণ সেটিংসের জন্য JSON টেমপ্লেট।

JSON প্রতিনিধিত্ব
{
  "renewalType": string,
  "kind": string
}
ক্ষেত্র
renewalType

string

বার্ষিক প্রতিশ্রুতি পরিকল্পনার জন্য পুনর্নবীকরণ সেটিংস। আরও বিশদ তথ্যের জন্য, প্রশাসক সহায়তা কেন্দ্রে পুনর্নবীকরণ বিকল্পগুলি দেখুন৷ একটি সাবস্ক্রিপশন পুনর্নবীকরণ করার সময়, renewalType একটি প্রয়োজনীয় সম্পত্তি।

kind

string

সাবস্ক্রিপশন পুনর্নবীকরণ সেটিং হিসাবে সংস্থানটিকে চিহ্নিত করে৷ মান: subscriptions#renewalSettings

পদ্ধতি

activate

 রিসেলার দ্বারা পূর্বে স্থগিত করা একটি সদস্যতা সক্রিয় করে৷

changePlan

 একটি সাবস্ক্রিপশন প্ল্যান আপডেট করে।

changeRenewalSettings

 ব্যবহারকারীর লাইসেন্সের নবায়ন সেটিংস আপডেট করে।

changeSeats

 একটি সদস্যতার ব্যবহারকারী লাইসেন্স সেটিংস আপডেট করে৷

delete

 সরাসরি সাবস্ক্রিপশন বাতিল, স্থগিত বা স্থানান্তর করে।

get

 একটি নির্দিষ্ট সাবস্ক্রিপশন পায়।

insert

 একটি সদস্যতা তৈরি বা স্থানান্তর করে।

list

 রিসেলার দ্বারা পরিচালিত সদস্যতার তালিকা।

startPaidService

 অবিলম্বে একটি 30-দিনের বিনামূল্যে ট্রায়াল সদস্যতা একটি প্রদত্ত পরিষেবা সদস্যতায় স্থানান্তর করুন৷

suspend

 একটি সক্রিয় সদস্যতা স্থগিত করে।