REST Resource: subscriptions

Kaynak: Abonelik

Bir aboneliğin JSON şablonu.

JSON gösterimi 
{
  "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
  }
}
Alanlar
customerId

string

Bu özellik, yanıtta her zaman Google tarafından oluşturulan benzersiz tanımlayıcı olarak döndürülür. Bir istekte bu mülk, birincil alan veya Google tarafından oluşturulan benzersiz tanımlayıcı olabilir.
subscriptionId

string

subscriptionId, abonelik tanımlayıcısıdır ve her müşteri için benzersizdir. Bu zorunlu bir özelliktir. Abonelik güncellendiğinde subscriptionId değiştiğinden kalıcı veriler için bu kimliği anahtar olarak kullanmamanızı öneririz. subscriptionId aracını tüm bayi aboneliklerini alma bölümünde açıklandığı şekilde kullanın.
skuId

string

Gerekli bir özellik. skuId, abonelikteki bir müşteriye atanan ürünün SKU'su için benzersiz bir sistem tanımlayıcısıdır. API'nin bu sürümünde kullanılabilen ürünler ve SKU'lar için Ürün ve SKU kimlikleri bölümüne bakın.
creationTime

string (int64 format)

creationTime özelliği, aboneliğin oluşturulduğu tarihtir. Bu değer, Epoch biçimi kullanılarak milisaniye cinsinden belirtilir. Örnek bir Epoch dönüştürücü bakın.
kind

string

Kaynağı abonelik olarak tanımlar. Değer: reseller#subscription
seats

object (Seats)

Bu zorunlu bir özelliktir. Plandaki kullanıcı lisansı lisansı sayısı ve sınırı.
renewalSettings

object (RenewalSettings)

Yıllık taahhüt planı için yenileme ayarları. Daha ayrıntılı bilgi için yönetici yardım merkezindeki yenileme seçeneklerine göz atın.
purchaseOrderId

string

Bu, isteğe bağlı bir özelliktir. Bu satın alma siparişi (PO) bilgileri, bayilerin şirket izleme kullanımları için kullanmaları içindir. purchaseOrderId değeri verilirse bu değer API yanıtlarında görünür ve faturada gösterilir. Tesiste en fazla 80 düz metin karakteri kabul edilir.
status

string

Bu, isteğe bağlı bir özelliktir.
resourceUiUrl

string

Müşterinin Yönetici Konsolu'ndaki Abonelikler sayfasının URL'si. Salt okunur URL, API hizmeti tarafından oluşturulur. Bu seçenek, istemci uygulamanız için müşterinin Yönetici konsolundaki Abonelikler sayfasını kullanarak bir görevi tamamlamasını gerektiriyorsa kullanılır.
billingMethod

string

Bir abonelik için geçerli faturalandırma yöntemini döndüren salt okunur alan.
suspensionReasons[]

string

Bir aboneliğin mevcut tüm askıya alma nedenlerini içeren bir numaralandırmayı içeren salt okunur alan. Bir aboneliğin eşzamanlı olarak birçok çakışan askıya alma nedeni olabilir. Bir aboneliğin STATUS tarihi, bekleyen tüm askıya alma işlemleri kaldırılana kadar SUSPENDED olacak.

Olası seçenekler şunlardır:

  • PENDING_TOS_ACCEPTANCE - Müşteri giriş yapmadı ve G Suite Yeniden Satışı Yapılan Hizmet Şartları'nı kabul etti.
  • RENEWAL_WITH_TYPE_CANCEL - Müşterinin taahhüdü sona erdi ve hizmet süresi sonunda hizmeti iptal edildi.
  • RESELLER_INITIATED - Bir bayi tarafından uygulanan manuel askıya alma.
  • TRIAL_ENDED: Müşterinin deneme süresi, bir plan seçilmeden sona erdi.
  • OTHER - Müşteri, Google'ın kendi kaynaklı bir nedenden dolayı (ör. kötüye kullanım veya başka bir nedenle) askıya alındı.

customerDomain

string

Müşterinin birincil alan adı
dealCode

string

Abonelik planlarında indirimli fiyatlar için Google tarafından verilen kod (en fazla 100 karakter). İndirimli ücret alabilmek için insert isteklerine fırsat kodunun dahil edilmesi gerekir. Bu özellik isteğe bağlıdır, boş bırakılırsa normal fiyatlandırma uygulanır.
skuName

string

Abonelikteki bir müşteriye atanan ürünün SKU'su için salt okunur harici görünen ad. SKU adları Google'ın takdirine bağlı olarak değiştirilebilir. API'nin bu sürümünde kullanılabilen ürünler ve SKU'lar için Ürün ve SKU kimlikleri bölümüne bakın.
plan

object

plan özelliği zorunludur. API'nin bu sürümünde G Suite planları esnek plan, yıllık taahhüt planı ve 30 günlük ücretsiz deneme planıdır. API'nin ödeme planları hakkında daha fazla bilgi için API kavramları bölümüne bakın.
plan.planName

string

planName özelliği zorunludur. Bu, abonelik planının adıdır. Google ödeme planları hakkında daha fazla bilgi için API kavramları başlıklı makaleyi inceleyin.

Olası değerler şunlardır:

  • ANNUAL_MONTHLY_PAY — Aylık ödemelerle yıllık taahhüt planı.
  • ANNUAL_YEARLY_PAY — Yıllık ödemelerle yıllık taahhüt planı
  • FLEXIBLE — Esnek plan
  • TRIAL — 30 günlük ücretsiz deneme planı. Deneme sürümündeki bir abonelik, ödeme planı atanmazsa 30. günden sonra askıya alınır. changePlan arandığında deneme süresi için bir ödeme planı atanır ancak plan etkinleştirilmez. Deneme sürümü, kendisine atanan ödeme planını 30. ücretsiz günden sonra veya startPaidService arandıktan hemen sonra otomatik olarak başlatır.
  • FREE: Ücretsiz plan, Cloud Identity SKU'ya özeldir ve faturalandırma gerektirmez.

plan.isCommitmentPlan

boolean

isCommitmentPlan özelliğinin boole değeri, planı yıllık taahhüt planı olarak tanımlar:

  • true — Aboneliğin planı, yıllık taahhüt planıdır.
  • false: Plan, yıllık taahhüt planı değildir.
plan.commitmentInterval

object

API'nin bu sürümünde, yıllık taahhüt planının aralığı bir yıldır.

plan.commitmentInterval.startTime

string (int64 format)

Yıllık taahhüt planının UNIX Epoch biçimi kullanılarak milisaniye cinsinden startTime aralığı. Örnek bir Epoch dönüştürücü bakın.
plan.commitmentInterval.endTime

string (int64 format)

Yıllık taahhüt planının UNIX Epoch biçimi kullanılarak milisaniye cinsinden endTime aralığı. Örnek bir Epoch dönüştürücü bakın.
trialSettings

object

G Suite yıllık taahhüdü ve esnek ödeme planları 30 günlük ücretsiz deneme süresi içinde olabilir. Daha fazla bilgi için API kavramları konusuna bakın.
trialSettings.isInTrial

boolean

Bir abonelik planının 30 günlük ücretsiz deneme süresi içinde olup olmadığını belirler:

  • true — Plan deneme süresindedir.
  • false - Plan, deneme süresinde değildir.
trialSettings.trialEndTime

string (int64 format)

Deneme süresinin sona erdiği tarih. Değer, UNIX Epoch biçimi kullanılarak milisaniye cinsinden belirtilir. Örnek bir Epoch dönüştürücü bakın.
transferInfo

object

Abonelik için salt okunur aktarımla ilgili bilgiler. Daha fazla bilgi edinmek için bir müşteri için aktarılabilir abonelikleri alma başlıklı makaleye bakın.
transferInfo.transferabilityExpirationTime

string (int64 format)

Aktarım jetonunun veya aktarım amacının süresinin dolacağı zaman. UNIX Epoch biçimi kullanılarak zaman milisaniye cinsinden belirtilir.
transferInfo.minimumTransferableSeats

integer

Abonelik eklerken bu, ürünün aktarım siparişinde listelenen minimum lisans sayısıdır. Örneğin, müşterinin 20 kullanıcısı varsa bayi 15 lisanslık bir aktarım siparişi veremez. Minimum lisans sayısı 20'dir.
transferInfo.currentLegacySkuId

string

Mevcut yeniden satışı yapılan aboneliğin skuId tutarı. Bu alan yalnızca müşterinin eski bir SKU'ya sahip aboneliği olduğunda ve abonelik kaynağı, aktarım için önerilen SKU'nun skuId değeri ile doldurulduğunda doldurulur.

Sandalye sayısı

Abonelik koltukları için JSON şablonu.

JSON gösterimi 
{
  "numberOfSeats": integer,
  "maximumNumberOfSeats": integer,
  "licensedNumberOfSeats": integer,
  "kind": string
}
Alanlar
numberOfSeats

integer

Bu, zorunlu bir mülktür ve ANNUAL_MONTHLY_PAY ile ANNUAL_YEARLY_PAY planları olan aboneliklere özeldir. Bu mülk, bir abonelikteki kullanıcılara atanabilecek maksimum lisans sayısını belirler. Bayi daha fazla lisans ekleyebilir. Ancak belirlenen numberOfSeats, yenileme tarihine kadar azaltılamaz. Bayi, bu kullanıcı lisanslarından kaç tanesinin atandığına bakılmaksızın numberOfSeats değerine göre faturalandırılır.

maximumNumberOfSeats

integer

Bu, zorunlu bir mülktür ve FLEXIBLE veya TRIAL planları olan aboneliklere özeldir. Bu mülk, bir abonelikte izin verilen maksimum lisanslı kullanıcı sayısını belirler. Bu miktar, bayi sözleşmesinde tanımlanan maksimum sınıra kadar artırılabilir. Minimum miktar, müşteri hesabındaki mevcut kullanıcı sayısıdır.

licensedNumberOfSeats

integer

skuId politikasında tanımlanan ürün için lisans atanan mevcut kullanıcıların sayısını içeren salt okunur alan. Bu alanın değeri, Enterprise License Manager API yöntemi tarafından döndürülen kullanıcıların sayısal sayısına eşdeğerdir: listForProductAndSku.
kind

string

Kaynağı abonelik lisans ayarı olarak tanımlar. Değer: subscriptions#seats

RenewalSettings

Abonelik yenileme ayarları için JSON şablonu.

JSON gösterimi 
{
  "renewalType": string,
  "kind": string
}
Alanlar
renewalType

string

Yıllık taahhüt planı için yenileme ayarları. Daha ayrıntılı bilgi için yönetici yardım merkezindeki yenileme seçeneklerine göz atın. Bir abonelik yenilenirken renewalType, zorunlu bir mülktür.
kind

string

Kaynağı abonelik yenileme ayarı olarak tanımlar. Değer: subscriptions#renewalSettings

Yöntemler

activate

 Daha önce bayi tarafından askıya alınmış bir aboneliği etkinleştirir.

changePlan

 Bir abonelik planını günceller.

changeRenewalSettings

 Kullanıcı lisansının yenileme ayarlarını günceller.

changeSeats

 Bir aboneliğin kullanıcı lisansı ayarlarını günceller.

delete

 Bir aboneliği iptal ettiği, askıya aldığı veya doğrudan yönlendirmeye aktardığı durumlarda.

get

 Belirli bir aboneliği alır.

insert

 Abonelik oluşturur veya aktarır.

list

 Bayi tarafından yönetilen aboneliklerin listeleri.

startPaidService

 30 günlük ücretsiz deneme aboneliğini hemen ücretli hizmet aboneliğine taşıyın.

suspend

 Etkin bir aboneliği askıya alır.