REST Resource: subscriptions

Kaynak: Abonelik

Abonelik iç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, Google tarafından oluşturulan benzersiz tanımlayıcı olarak her zaman bir yanıtta döndürülür. Bir istekteki 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, bu kimliği kalıcı veriler için anahtar olarak kullanmamanızı öneririz. Tüm bayi aboneliklerini alma bölümünde açıklandığı gibi subscriptionId öğesini kullanın.
skuId

string

Zorunlu bir özellik. skuId, abonelikte 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 mülkü, aboneliğin oluşturulduğu tarihtir. Epoch biçiminde milisaniye cinsindendir. Örnek bir dönem dönüştürücüye bakın.
kind

string

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

object (Seats)

Bu zorunlu bir özelliktir. Plandaki kullanıcı koltuğu 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 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 kullanması amacıyla sağlanmıştır. purchaseOrderId değeri verilirse API yanıtlarında ve faturada gösterilir. Özellik, en fazla 80 düz metin karakteri kabul eder.
status

string

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

string

Müşterinin Yönetici Konsolu'ndaki Abonelikler sayfasının URL'si. Salt okuma URL'si API hizmeti tarafından oluşturulur. Müşterinin, istemci uygulamanızda Yönetici Konsolu'ndaki Abonelikler sayfasını kullanarak bir görevi tamamlaması gerekiyorsa bu parametre kullanılır.
billingMethod

string

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

string

Bir aboneliğin mevcut tüm askıya alma nedenlerinin bir dizini içeren salt okunur alan. Bir aboneliğin birden fazla, çakışan askıya alma nedeni olabilir. Beklemedeki tüm askıya alma işlemleri kaldırılana kadar aboneliğin STATUS değeri SUSPENDED olur.

Olası seçenekler şunlardır:

  • PENDING_TOS_ACCEPTANCE: Müşteri oturum açmamış ve G Suite Yeniden Satılan Hizmet Şartları'nı kabul etmemiştir.
  • RENEWAL_WITH_TYPE_CANCEL: Müşterinin taahhüt süresi sona erdi ve hizmet sözleşmesi iptal edildi.
  • RESELLER_INITIATED: Bayi tarafından başlatılan manuel askıya alma.
  • TRIAL_ENDED: Müşterinin deneme süresi, plan seçilmeden sona erdi.
  • OTHER: Müşteri, Google'ın dahili bir nedeni (ör. kötüye kullanım veya başka bir neden) nedeniyle 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 (maks. 100 karakter). İndirimli fiyattan yararlanmak için fırsat kodu insert isteklerine eklenmelidir. Bu özellik isteğe bağlıdır. Boş bırakılırsa normal fiyat geçerli olur.
skuName

string

Abonelikte 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 gereklidir. 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ı başlıklı makaleyi inceleyin.
plan.planName

string

planName özelliği gereklidir. Bu, aboneliğin planının adıdır. Google ödeme planları hakkında daha fazla bilgi için API kavramları bölümüne bakın.

Olası değerler:

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

plan.isCommitmentPlan

boolean

isCommitmentPlan mülkünün 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 aralığı (UNIX Epoch biçiminde milisaniye cinsinden) startTime. Örnek bir dönem dönüştürücüye bakın.
plan.commitmentInterval.endTime

string (int64 format)

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

object

G Suite yıllık taahhüt ve esnek ödeme planları 30 günlük ücretsiz deneme süresinde kullanılabilir. Daha fazla bilgi için API kavramları başlıklı makaleyi inceleyin.
trialSettings.isInTrial

boolean

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

  • true: Plan deneme sürümündedir.
  • false: Plan deneme sürümünde değil.
trialSettings.trialEndTime

string (int64 format)

Denemenin sona erdiği tarih. Değer, UNIX Epoch biçiminde milisaniye cinsindendir. Örnek bir dönem dönüştürücüye bakın.
transferInfo

object

Abonelikle ilgili salt okunur aktarım bilgileri. Daha fazla bilgi için bir müşterinin aktarılabilir aboneliklerini alma başlıklı makaleyi inceleyin.
transferInfo.transferabilityExpirationTime

string (int64 format)

Aktarım jetonunun veya aktarım niyetinin süresinin sona ereceği zaman. Zaman, UNIX Epoch biçiminde milisaniye cinsindendir.
transferInfo.minimumTransferableSeats

integer

Abonelik eklenirken bu ürün için aktarım siparişinde listelenen minimum koltuk sayısıdır. Örneğin, müşterinin 20 kullanıcısı varsa bayi 15 koltuk için aktarım siparişi veremez. Minimum 20 koltuk olmalıdır.
transferInfo.currentLegacySkuId

string

Mevcut yeniden satılan aboneliğin skuId. Bu alan yalnızca müşterinin eski bir SKU'ya sahip olduğu ve abonelik kaynağı, aktarım için önerilen SKU'nun skuId değeriyle 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 özellik, ANNUAL_MONTHLY_PAY ve ANNUAL_YEARLY_PAY planlarına sahip aboneliklere özeldir. Bu özellik, bir abonelikteki kullanıcılara atanabilecek maksimum lisans sayısını belirler. Bayi daha fazla lisans ekleyebilir ancak numberOfSeats, abonelik yenilenene kadar ayarlandıktan sonra 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 özellik, FLEXIBLE veya TRIAL planlarına sahip aboneliklere özeldir. Bu özellik, 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 içinde tanımlanan ürün için lisans atanmış 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 kullanıcıların sayısal sayısına (listForProductAndSku) eşittir.
kind

string

Kaynağı abonelik koltuğu 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. Abonelik yenilenirken renewalType gerekli bir özelliktir.
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 doğrudan aboneliğe aktarır.

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 bir hizmet aboneliğine taşıyabilirsiniz.

suspend

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