REST Resource: subscriptions

Kaynak: Abonelik

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. İstekte bu özellik, 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 anahtar olarak bu kimliği kullanmamanızı öneririz. subscriptionId hizmetini tüm bayi aboneliklerini alma konusunda açıklandığı şekilde kullanın.
skuId

string

Zorunlu bir mülk. skuId, abonelik kapsamındaki 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. Epoch biçimi kullanılarak milisaniye cinsinden belirtilir. Epoch dönüştürücü örneğini inceleyin.
kind

string

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

object (Seats)

Bu, zorunlu bir özelliktir. Plandaki kullanıcı lisansı lisanslarının 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 bakın.
purchaseOrderId

string

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

string

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

string

Yönetici konsolundaki Abonelikler sayfasının URL'si. Salt okunur URL, API hizmeti tarafından oluşturulur. Müşteri uygulamanız, Yönetici konsolundaki Abonelikler sayfasını kullanarak müşterinin bir görevi tamamlamasını gerektiriyorsa bu yöntem kullanılır.
billingMethod

string

Bir aboneliğin mevcut faturalandırma yöntemini döndüren salt okunur alan.
suspensionReasons[]

string

Abonelikteki mevcut tüm askıya alma nedenlerinin sayısını içeren salt okunur alan. Bir aboneliğin birçok eşzamanlı, çakışan askıya alma nedeni olması mümkündür. Bekleyen tüm askıya alma işlemleri kaldırılana kadar abonelik STATUS değeri SUSPENDED olarak belirlenmiştir.

Olası seçenekler şunlardır:

  • PENDING_TOS_ACCEPTANCE - Müşteri giriş yapmamış ve G Suite Yeniden Satışı Yapılan Hizmet Şartları'nı kabul etmiştir.
  • RENEWAL_WITH_TYPE_CANCEL - Müşterinin taahhüdü sona erdi ve hizmet süresi dönem sonunda iptal edildi.
  • RESELLER_INITIATED - Bir Bayi tarafından çağrılan manuel askıya alma.
  • TRIAL_ENDED - Müşterinin deneme süresi herhangi bir plan seçilmedi.
  • OTHER - Müşteri, dahili bir Google nedeniyle (ör. kötüye kullanım veya askıya alma) askıya alındı.

customerDomain

string

Müşterinin birincil alan adı
dealCode

string

Abonelik planlarında indirimli fiyatlandırma için Google tarafından verilen kod (en fazla 100 karakter). İndirimli indirimden yararlanabilmek için insert isteklerine fırsat kodu eklenmelidir. 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 SKU'su için salt okunur harici görünen ad. SKU adları Google’ın şahsi karar verme yetkisine tabidir. 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'lerin ödeme planları hakkında daha fazla bilgi edinmek için API kavramları başlıklı makaleyi inceleyin.
plan.planName

string

planName özelliği zorunludur. Bu, abonelik planının adıdır. Google ödeme planları hakkında daha fazla bilgi edinmek 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 ödemeleri içeren yıllık taahhüt planı
  • FLEXIBLE — Esnek plan
  • TRIAL - 30 günlük ücretsiz deneme planı. Hiçbir ödeme planı atanmazsa deneme süresindeki abonelik 30 gün sonra askıya alınır. changePlan araması, deneme sürümüne bir ödeme planı atar ancak planı etkinleştirmez. Deneme, atanan ödeme planını 30. ücretsiz gününden sonra veya startPaidService numaralı telefonu aradıktan hemen sonra otomatik olarak başlatır.
  • FREE: Ücretsiz plan, Cloud Identity SKU'ya özeldir ve faturalandırılmaz.

plan.isCommitmentPlan

boolean

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

  • true - Abonelik planı yıllık bir 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)

UNIX Epoch biçimini kullanan milisaniye cinsinden yıllık taahhüt planıstartTime. Epoch dönüştürücü örneğini inceleyin.
plan.commitmentInterval.endTime

string (int64 format)

UNIX Epoch biçimini kullanarak milisaniye cinsinden yıllık taahhüt planıendTime. Epoch dönüştürücü örneğini inceleyin.
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ı başlıklı makaleyi inceleyin.
trialSettings.isInTrial

boolean

Bir abonelik planının 30 günlük ücretsiz deneme süresinde olup olmadığını belirler:

  • true — Plan deneme aşamasında.
  • false - Plan deneme aşamasında değildir.
trialSettings.trialEndTime

string (int64 format)

Deneme süresinin sona ereceği tarih. Bu değer, UNIX Epoch biçimi kullanılarak milisaniye cinsinden belirtilir. Epoch dönüştürücü örneğini inceleyin.
transferInfo

object

Abonelik için aktarımla ilgili salt okunur bilgiler. Daha fazla bilgi edinmek üzere bir müşteri için aktarılabilir abonelikleri alma bölümünü inceleyin.
transferInfo.transferabilityExpirationTime

string (int64 format)

Aktarım jetonunun veya aktarım niyetinin süresi sona erer. UNIX Epoch biçimi kullanılarak saat milisaniye cinsinden belirtilir.
transferInfo.minimumTransferableSeats

integer

Abonelik eklerken bu değer, ürünün aktarım sırasında 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

Yeniden satışı yapılan mevcut aboneliğin skuId oranı. Bu alan yalnızca müşterinin eski bir SKU'ya sahip bir aboneliği varsa ve abonelik kaynağı aktarım için önerilen SKU'nun skuId değeriyle doldurulur.

Sandalye sayısı

Abonelik lisansları için JSON şablonu.

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

integer

Bu zorunlu bir özelliktir ve ANNUAL_MONTHLY_PAY ile ANNUAL_YEARLY_PAY planlarına sahip aboneliklere özeldir. Bu mülk, bir abonelikteki kullanıcılara atanabilecek maksimum lisans sayısını belirler. Bayi daha fazla lisans ekleyebilir, ancak belirlendikten sonra numberOfSeats lisans yenilenene kadar azaltılamaz. Bayi, kaç kullanıcı lisansı atanmış olursa olsun numberOfSeats değerine göre faturalandırılır.

maximumNumberOfSeats

integer

Bu, gerekli bir özelliktir ve FLEXIBLE veya TRIAL planlarına sahip 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 ürününde tanımlanan ürüne lisans atanmış olan mevcut kullanıcı 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 sayısal kullanıcı sayısına eşdeğerdir: listForProductAndSku.
kind

string

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

Yenileme Ayarları

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 bakı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ınan bir aboneliği etkinleştirir.

changePlan

 Abonelik planını günceller.

changeRenewalSettings

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

changeSeats

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

delete

 Aboneliği iptal eder, askıya alır veya yönlendirmek üzere aktarır.

get

 Belirli bir aboneliği edinir.

insert

 Abonelik oluşturur veya aktarır.

list

 Bayi tarafından yönetilen aboneliklerin listesi.

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.