active, trialing, past_due vb.), mevcut dönemi, bekleyen iptalleri, özel meta verileri ve ürün lisanslama içeriyorsa yazılım lisans anahtarını takip eder.
Bir hesabın üyeliklerini veya kendi üyeliklerinizi listelemek, birini kimliğe veya lisans anahtarına göre almak, bir alıcıyı ücretsiz bir varyant üzerinden katılmaya davet etmek ve yaşam döngüsünü yönetmek için Memberships API’sini kullanın: hemen veya dönem sonunda iptal etme, planlanmış bir iptali geri alma, ödeme tahsilatını duraklatma ve sürdürme, erişimi uzatma veya yeniden etkinleştirme, promosyon kodu veya satış ortağı uygulama, yenileme sıklığını değiştirme, erişimi yeniden eşitleme, transfer bağlantısı oluşturma ve meta verileri güncelleme.
Legacy Memberships kaynağının yerini alır. Mevcut Legacy entegrasyonları çalışmaya devam eder; kararlılık sözleşmesi için API sürümleri sayfasına bakın.
Uç noktalar
Öznitelikler
Bu üyeliğin ait olduğu hesap (satıcı).
Üyeliğin satış ortaklığı komisyonu. Satış ortağı yoksa, hesapta
affiliate:basic:read izni yoksa ve webhook’larda her zaman null olur.Properties
Properties
Komisyonun yalnızca üyeliğin ilk ödemesinde mi yoksa tüm ödemelerinde mi ödendiği.Kullanılabilir seçenekler:
first_payment, all_paymentsÜyelik para birimindeki sabit ücretli komisyon veya yüzde için
null.Properties
Properties
Ana birim cinsinden, tam ondalık dize olarak tutar. Örneğin
"10.00" on dolardır. Aktarım sırasında hiçbir kayan nokta sayısının onu yuvarlamaması için dize olarak verilir.Tutarın kaç ondalık basamak taşıdığı. Bu, tahsilatın kendisinin çalıştığı hassasiyettir.
Yüzde puanı cinsinden yüzde komisyonu (yani
20, %20 anlamına gelir) veya sabit ücret için null.Komisyon oranının nasıl belirlendiği: bu satış ortağı için belirlenen bir oran için
custom, planın veya ürünün üye satış ortaklığı oranı için member, ürünün genel satış ortaklığı oranı için global veya bir Whop pazar yeri yönlendirmesi için marketplace.Kullanılabilir seçenekler: custom, member, marketplace, globalKomisyonun yüzde mi yoksa sabit ücret mi olduğu.Kullanılabilir seçenekler:
flat_fee, percentageBu üyeliğin satış ortaklığı komisyonu ödeyip ödemediği.
false, satış ortağının üyelikte tutulduğu ancak artık ödeme almadığı anlamına gelir.Yinelenen tahsilatlar arasındaki gün sayısı. Yenilenmeyen üyelikler veya birden fazla yenileme takvimine sahip üyelikler için
null olur.Üyeliğin mevcut faturalama dönemi sona erdiğinde iptal edilecek şekilde ayarlanıp ayarlanmadığı. Yalnızca yinelenen varyantlar için anlamlıdır.
Üyenin iptal nedeni olarak seçtiği kategori. Kategori seçilmediyse
null olur.Kullanılabilir seçenekler: too_expensive, switching, missing_features, technical_issues, bad_experience, unused, other, testingİptalin talep edildiği zaman veya talep zamanı kaydedilmemişse üyeliğin iptal edildiği zaman, ISO 8601 zaman damgası olarak. Hiçbiri kaydedilmemişse
null olur.İptal sırasında sağlanan serbest metin açıklaması. Neden belirtilmediyse
null olur.Yenilemelerin nasıl tahsil edildiği.
charge_automatically her dönem kayıtlı ödeme yönteminden tahsilat yapar; send_invoice her dönem alıcıya e-postayla bir fatura gönderir. Ayarlanmamışsa null olur.Kullanılabilir seçenekler: charge_automatically, send_invoiceMevcut faturalama döneminin yenilendiği zaman veya yenilenmeyen bir üyeliğin sona erdiği zaman, ISO 8601 zaman damgası olarak. Son kullanma tarihi olmayan tek seferlik satın alımlar için
null olur.Mevcut faturalama döneminin başladığı zaman, ISO 8601 zaman damgası olarak. Faturalama dönemi kaydedilmemişse
null olur.Sabit bir bitiş tarihine sahip bir üyelik için erişimin sona erdiği zaman, ISO 8601 zaman damgası olarak. Üyeliğin bitiş tarihi olmadığında (ör. yenilenen bir üyelik)
null olur.Üyenin Discord ve Telegram gibi harici platformlardaki hesapları. Üyenin bağlı hesabı yoksa boştur. Webhook’larda
null olur.Properties
Properties
Üyenin platformdaki kullanıcı kimliği, örneğin bir Discord kullanıcı kimliği. Platform önekiyle (
discord_\<external_id>) birlikte, List Memberships’in filtrelediği external_account değeridir.Varyantın, varyantın para birimindeki mevcut peşin fiyatı. Bu bir liste fiyatıdır; alıcının ödediği tutar olmayabilir. İlk tahsilat ücretsiz olduğunda
amount değeri "0.00" olur.Properties
Properties
Ana birim cinsinden, tam ondalık dize olarak tutar. Örneğin
"10.00" on dolardır. Aktarım sırasında hiçbir kayan nokta sayısının onu yuvarlamaması için dize olarak verilir.Tutarın kaç ondalık basamak taşıdığı. Bu, tahsilatın kendisinin çalıştığı hassasiyettir.
Bu üyeliğin yazılım lisans anahtarı. Yalnızca ürün bir yazılım lisanslama deneyimi içerdiğinde bulunur.
Alıcının faturalamayı yönetmek için oturum açabileceği URL. Üye kaydı yoksa veya çağıran alıcı değilse ya da hesapta
member:manage iznine sahip değilse null olur.Çağıranın hesaptaki üye satırı. Yalnızca üyelik çağırana ait olduğunda bulunur; satıcı tarafı okumalarda
null olur.Properties
Properties
Üyenin hesapta neye erişebildiği: ödeme yapan üyeler için
customer, ekip üyeleri için admin, tüm erişim izinlerinin süresi dolduğunda no_access.Kullanılabilir seçenekler: no_access, admin, customerÜyenin hesabın içeriğini en son açtığı zaman, ISO 8601 zaman damgası olarak. Hiç açmadıysa
null olur.Alıcının hesaptaki
mber_ önekli üye kaydı. Üyeliğin üye kaydı olmadığında (ör. talep edilmemiş bir üyelik) null olur.Üyelik üzerinde saklanan, genellikle yazılım lisanslama için kullanılan özel anahtar-değer çiftleri.
Üyeliğin en son yaşam döngüsü olayı; örneğin
renewing_on veya canceled_on. Bunu most_recent_action_at ile birlikte kullanın. Hiçbiri kaydedilmemişse null olur.Kullanılabilir seçenekler: canceled_on, finished_split_pay_at, canceling_on, ending_on, renewing_on, past_due, next_payment_attempt, paused_at, trial_ends_at, unresolved_at, trial_canceling_onmost_recent_action olayının gerçekleştiği veya gerçekleşmesinin planlandığı zaman, ISO 8601 zaman damgası olarak. renewing_on gibi yaklaşan olaylar için gelecekteki bir zamandır. Eylem kaydedilmemişse null olur.Alıcının bu üyelik için kaydedilmiş telefon numarası veya
null. Satıcının telefon toplama özelliği açıksa ödeme sırasında toplanan (veya doğrulanan) numaradır; alıcı bu satıcıyla paylaştıysa hesap numarasına geri döner.Bu üyeliğe indirim uygulayan
promo_ önekli promosyon kodu. Hiçbiri uygulanmadıysa null olur. Ödeme sırasında veya Apply Promo Code to Membership ile ayarlanır.Hâlâ geçerli olan herhangi bir promosyon kodundan sonra, varyantın para birimindeki yenileme fiyatı. Alıcının yerel para biriminde faturalandırılan bir üyelikten, her faturalama tarihinde bu fiyatın o tarihteki döviz kuruyla dönüştürülmüş hali tahsil edilir. Yenilenmeyen üyelikler için
null olur.Properties
Properties
Ana birim cinsinden, tam ondalık dize olarak tutar. Örneğin
"10.00" on dolardır. Aktarım sırasında hiçbir kayan nokta sayısının onu yuvarlamaması için dize olarak verilir.Tutarın kaç ondalık basamak taşıdığı. Bu, tahsilatın kendisinin çalıştığı hassasiyettir.
Bölünmüş ödemeli bir üyelikte şu ana kadar sayılan ödenmiş taksitler. Üyelik bölünmüş ödemede değilse veya ilk taksiti sayılmadan önce
null olur.Üyeliğin faturalamayı durdurmasından önce gereken taksit ödemeleri. Üyelik bölünmüş ödemede değilse
null olur.Üyeliğin faturalama durumu.
active/trialing üyelikler erişim sağlar; past_due, başarısız bir ödemeden sonraki ek süredir; completed tek seferlik satın alımlar erişimi korur; canceled/expired üyelikler erişim sağlamaz.Kullanılabilir seçenekler: trialing, active, past_due, completed, canceled, expired, unresolvedÜyeliğin en son değiştirildiği zaman, ISO 8601 zaman damgası olarak. Üyeliğin kendisindeki en son değişikliği yansıtır; böylece webhook yeniden denemeleri, yeniden oynatmalar ve geriye dönük doldurmalarla mutabakat yapabilirsiniz.
user_ önekli alıcı. Alıcı başka bir işletme olduğunda veya üyelik talep edilmemişse null olur.Membership

