Skip to main content
Ürünler API’sini herkese açık pazaryerinde arama yapmak, bir hesabın ürünlerini listelemek, bir ürünü almak ve ürün oluşturmak, güncellemek veya silmek için kullanın.
Eski Ürünler kaynağının yerini alır. Mevcut Eski entegrasyonlar çalışmaya devam eder; kararlılık sözleşmesi için API sürümleri sayfasına bakın.

Uç noktalar

Öznitelikler

string
gerekli
prod_ önekli ürün kimliği.
object | null
gerekli
Bu ürünü satan hesap.
number
gerekli
Bu ürün için yayımlanmış değerlendirmelerin 1.0 ile 5.0 arasındaki ortalama yıldız puanı. Yayımlanmış değerlendirme puanı yoksa 0.0 döndürür.
string
gerekli
Ürünün oluşturulduğu zaman, ISO 8601 zaman damgası olarak.
string | null
gerekli
Ürün satın alma sayfasında gösterilen harekete geçirici düğme etiketi.Kullanılabilir seçenekler: get_access, join, order_now, shop_now, call_now, donate_now, contact_us, sign_up, subscribe, purchase, get_offer, apply_now, complete_order
string | null
gerekli
Harekete geçirici düğmenin ödeme sayfası yerine bağlandığı URL.
string | null
gerekli
Müşterinin banka ekstresindeki özel metin etiketi.
object | null
gerekli
Gösterilecek ve ödeme yapılacak satın alınabilir varyant. Yapılandırılmış varsayılan varyant satın alınabilirse o, aksi takdirde ürün sayfası sırasındaki ilk satın alınabilir varyant. Hiçbiri satın alınabilir değilse null.

Özellikler

string
gerekli
plan_ önekli varyant kimliği.
number | null
gerekli
Yinelenen tahsilatlar arasındaki gün sayısı, örneğin aylık için 30 veya yıllık için 365. Tek seferlik varyantlar için null.
string
gerekli
Bu varyantın faturalandırma modeli: one_time veya renewal.Kullanılabilir seçenekler: renewal, one_time
number | null
gerekli
Süre sonu tabanlı varyantlar için gün cinsinden erişim süresi. Süre sonu olmayan varyantlar için null.
object
gerekli
Ödeme sayfasının peşin olarak tahsil ettiği tutar. İlk tahsilat deneme süresi gibi ücretsiz olduğunda amount değeri "0.00" olur.

Özellikler

string
gerekli
Ana birim cinsinden tutar, tam bir ondalık dize olarak. Örneğin "10.00" on dolardır. Aktarım sırasında hiçbir kayan nokta sayısının onu yuvarlamaması için dizedir.
string
gerekli
Küçük harfli, üç harfli ISO 4217 para birimi kodu.
integer
gerekli
Tutarın kaç ondalık basamak taşıdığı. Bu, tahsilatın kendisinin çalıştığı hassasiyettir.
integer
gerekli
Kaç ondalık basamağın GÖSTERİLECEĞİ. Genellikle decimals ile eşittir, ancak bilinçli olarak her zaman değil: COP centavo cinsinden tahsil edilir ancak tam peso olarak yazılır, bu yüzden 2 ve 0 olur. Sayıyı bunu kullanarak kendi yerel ayarınızda biçimlendirin.
object
gerekli
Her billing_period günde bir yapılan yinelenen tahsilat. Tek seferlik varyantlar için amount değeri "0.00" olur.

Özellikler

string
gerekli
Ana birim cinsinden tutar, tam bir ondalık dize olarak. Örneğin "10.00" on dolardır. Aktarım sırasında hiçbir kayan nokta sayısının onu yuvarlamaması için dizedir.
string
gerekli
Küçük harfli, üç harfli ISO 4217 para birimi kodu.
integer
gerekli
Tutarın kaç ondalık basamak taşıdığı. Bu, tahsilatın kendisinin çalıştığı hassasiyettir.
integer
gerekli
Kaç ondalık basamağın GÖSTERİLECEĞİ. Genellikle decimals ile eşittir, ancak bilinçli olarak her zaman değil: COP centavo cinsinden tahsil edilir ancak tam peso olarak yazılır, bu yüzden 2 ve 0 olur. Sayıyı bunu kullanarak kendi yerel ayarınızda biçimlendirin.
string | null
gerekli
Müşterilere gösterilen varyant görünen adı. Başlık ayarlanmamışsa null.
number | null
gerekli
İlk yenileme tahsilatından önceki ücretsiz deneme günleri. Deneme yapılandırılmamışsa veya oturum açmış kullanıcı bu varyantta zaten bir deneme kullanmışsa null.
boolean
gerekli
Varyantın sınırsız stoğa sahip olup olmadığı.
string
gerekli
Bu varyantın nerede görülebileceği. visible varyantlar ürün sayfasında görünür.Kullanılabilir seçenekler: visible, hidden, archived, quick_link
string | null
gerekli
Ürün sayfasında gösterilen yazılı açıklama. Ayarlanmamışsa null.
object[]
gerekli
Ürünün içerdiği kurslar, sohbetler ve uygulamalar gibi deneyimler, en eski önce. İlk 100 tanesini içerir; geri kalanını GET /experiences?product_id= ile sayfalayın.

Özellikler

string
gerekli
exp_ önekli deneyim kimliği.
object
gerekli
Deneyimin çalıştığı uygulama.

Özellikler

string
gerekli
app_ önekli uygulama kimliği.
object
gerekli
Uygulama simgesi. Hiçbiri yüklenmemişse varsayılan uygulama simgesine geri döner.

Özellikler

string
gerekli
Simge görsel URL’si. Her zaman mevcuttur — hiçbiri yüklenmemişse varsayılan uygulama simgesidir.
string
gerekli
Uygulamanın görünen adı.
string | null
gerekli
Bu deneyim için yüklenen logo görsel URL’si. Yoksa null; bunun yerine uygulamanın icon değerini gösterin.
string
gerekli
Deneyimin görünen adı.
string | null
gerekli
Kendi referansınız için üründe saklanan harici tanımlayıcı.
Bu ürünün galeri görselleri, konuma göre sıralanmış.

Özellikler

string
gerekli
Galeri görseli kimliği.
string | null
gerekli
Yüklenen dosyanın MIME türü, örneğin image/jpeg.
string | null
gerekli
Bu görseli istemcide görüntülemek için önceden optimize edilmiş URL.
number | null
gerekli
Satış ortaklarının genel satış ortaklığı programı aracılığıyla kazandığı komisyon oranı.
string | null
gerekli
Genel satış ortaklığı programındaki kayıt durumu.Kullanılabilir seçenekler: enabled, disabled
string | null
gerekli
Ürün sayfasında gösterilen kısa pazarlama başlığı.
string[]
gerekli
Ürünleri koleksiyonlarda gruplamak için kullanılan küçük harfli etiketler. Tek bir koleksiyonu getirmek için listeleme uç noktasını labels ile filtreleyin.
string | null
gerekli
Ürün sayfalarında ve arama sonuçlarında gösterilen logo görsel URL’si. Ürünün logosu yoksa null.
string
gerekli
whop.com pazaryerindeki listeleme durumu. pending_review, gönderildiği ve inceleme beklediği anlamına gelir; live_marketplace, onaylandığı ve keşfedilebilir olduğu anlamına gelir.Kullanılabilir seçenekler: not_available, pending_review, live_marketplace
number | null
gerekli
Üyelerin üye satış ortaklığı programı aracılığıyla kazandığı komisyon oranı.
string | null
gerekli
Üye satış ortaklığı programındaki kayıt durumu.Kullanılabilir seçenekler: enabled, disabled
number
gerekli
Bu ürün için aktif üyelikler; herkese açık üye sayıları devre dışıysa 0.
object | null
gerekli
Üründe saklanan özel anahtar-değer çiftleri.
object | null
gerekli
Bu ürünü satan hesabın sahibi olan kullanıcı.
object | null
gerekli
Bu ürünün vergi sınıflandırma kodu veya vergi kodu ayarlanmamışsa null.
number
gerekli
Bu ürün için yayımlanmış müşteri değerlendirmeleri.
string
gerekli
Ürünün herkese açık bağlantısı için URL slug’ı.
string
gerekli
Müşterilere gösterilen ürün görünen adı.
string
gerekli
Ürünün en son güncellendiği zaman, ISO 8601 zaman damgası olarak.
object | null
gerekli
Ürünün varyantlarının kapsadığı seçenek seti; öznitelik adından kullanımdaki değerlere bir eşleme olarak, ör. \{"color": ["Blue", "Red"], "size": ["S", "M", "L"]}. attributes taşıyan, görünür ve fatura dışı varyantlardan türetilir: anahtarlar alfabetik, değerler varyantların oluşturulma sırasına göre. Salt okunur. Ürünün varyantı yoksa null.
object[] | null
gerekli
Ürünün visibility değeri visible olan ve bir fatura için oluşturulmamış varyantları, oluşturulma sırasına göre. Düz fiyatlandırma seçenekleri attributes: null ile dahil edilir. Gizli, arşivlenmiş, hızlı bağlantılı ve fatura varyantlarına GET /variants aracılığıyla erişilebilir. Ürünün 1000’den fazla varyantı olduğunda (GET /variants?product_ids= ile sayfalayın) ve webhook yüklerinde null.

Özellikler

string
gerekli
plan_ önekli varyant kimliği.
object | null
gerekli
Bu varyantı satan hesap; bağımsız fatura varyantları için null.

Özellikler

string
gerekli
biz_ önekli hesap kimliği.
string
gerekli
Hesabın görünen adı.
boolean
gerekli
Bu varyant için uyarlanabilir fiyatlandırmanın etkin olup olmadığı. Ham ayardır — işlemci uyumluluğunu veya özellik bayraklarını kontrol etmez.
boolean
gerekli
Bir siparişte birden fazla adet satın alınıp alınamayacağı. Yenileme varyantları bunu etkinleştiremez. false olduğunda ödeme sayfaları, sepetler ve faturalar 1’den büyük miktarı reddeder.
object | null
gerekli
Bu varyantı ürünü içinde ayırt eden öznitelik değerleri; öznitelik adından değere bir eşleme olarak, ör. \{"color": "Blue", "size": "Large"}. Adlar snake_case tanımlayıcılardır ve alfabetik sırayla döner. Bir üründeki öznitelikli her varyant aynı öznitelik adlarını ve farklı bir değer setini taşır; ürün, seçenek setinin tamamını variant_attributes olarak listeler. Varyantın özniteliği yoksa null.
number | null
gerekli
Yinelenen tahsilatlar arasındaki gün sayısı, örneğin aylık için 30 veya yıllık için 365. Tek seferlik varyantlar için null.
string
gerekli
Bu varyantın faturalandırma modeli.Kullanılabilir seçenekler: renewal, one_time
number | null
gerekli
İptal indiriminin ne kadar süreceği: sonsuza kadar için 0, yalnızca bir sonraki ödeme için 1 veya müşterinin kabul ettiği andan itibaren takvim ayı sayısı. Sunulmuyorsa veya aktör plan:basic:read kapsamına sahip değilse null.
number | null
gerekli
Tam sayı yüzdesi olarak iptal indirimi. Sunulmuyorsa veya aktör plan:basic:read kapsamına sahip değilse null.
object | null
gerekli
Varyant düzeyinde ödeme sayfası stili (background_color, button_color, font_family, border_style); null hesap varsayılanını devralır.
string
gerekli
Varyantın oluşturulduğu zaman, ISO 8601 zaman damgası olarak.
string
gerekli
Bu varyanttaki her fiyatın belirtildiği para biriminin küçük harfli, üç harfli ISO 4217 kodu: varyantın kendi para birimi veya varyant ona dönüştürülebildiğinde okuma isteğinin talep ettiği presentment_currency.
object[]
gerekli
Ödeme formunda toplanan özel giriş alanları.

Özellikler

string
gerekli
field_ önekli özel alan kimliği.
string
gerekli
Özel alan giriş türü.Kullanılabilir seçenekler: text
string
gerekli
Ödeme sırasında müşteriye gösterilen alan etiketi.
number
gerekli
Alanın ödeme formundaki konumu.
string | null
gerekli
Boş alanda gösterilen yer tutucu metin. Ayarlanmamışsa null.
boolean
gerekli
Müşterinin ödeme yapmak için bu alanı doldurması gerekip gerekmediği.
string | null
gerekli
Müşterilerin görebildiği varyant açıklaması. En fazla 1000 karakter. Açıklama ayarlanmamışsa null.
number | null
gerekli
Süre sonu tabanlı varyantlar için gün cinsinden erişim süresi, örneğin bir yıllık geçiş için 365. Süre sonu olmayan varyantlar için null.
string
gerekli
Görüntüleme için currency cinsinden insan tarafından okunabilir fiyat (para birimi + aralık), ör. “$10 / month”.
object | null
gerekli
Ürün sayfasında gösterilen fiyatlandırma kademesi görseli (url, blurhash); görsel ayarlanmamışsa null.
number
gerekli
currency cinsinden ilk satın alma fiyatı.
object
gerekli
Promosyon kodları ve vergiden önce bir adet için ödeme sırasında tahsil edilen toplam: yinelenen varyantlar için initial_price artı ilk renewal_price veya ücretsiz deneme geçerliyken yalnızca initial_price. Görüntüleyen kullanıcı bu varyant için zaten bir deneme kullanmışsa deneme geçerli olmaz. currency cinsinden belirtilir.

Özellikler

string
gerekli
Ana birim cinsinden tutar, tam bir ondalık dize olarak. Örneğin "10.00" on dolardır. Aktarım sırasında hiçbir kayan nokta sayısının onu yuvarlamaması için dizedir.
string
gerekli
Küçük harfli, üç harfli ISO 4217 para birimi kodu.
integer
gerekli
Tutarın kaç ondalık basamak taşıdığı. Bu, tahsilatın kendisinin çalıştığı hassasiyettir.
integer
gerekli
Kaç ondalık basamağın GÖSTERİLECEĞİ. Genellikle decimals ile eşittir, ancak bilinçli olarak her zaman değil: COP centavo cinsinden tahsil edilir ancak tam peso olarak yazılır, bu yüzden 2 ve 0 olur. Sayıyı bunu kullanarak kendi yerel ayarınızda biçimlendirin.
string | null
gerekli
Müşterilere gösterilmeyen özel notlar. Aktör varyantın hesabında plan:basic:read kapsamına sahip değilse null.
object | null
gerekli
Bu varyantın oluşturulduğu fatura; bir fatura için oluşturulmadıysa null.
number | null
gerekli
Bu varyant üzerinden aktif üyelikler. Aktör varyantın hesabında plan:basic:read kapsamına sahip değilse null.
object | null
gerekli
Varyantta saklanan özel anahtar-değer çiftleri. Ödeme ve üyelik olaylarının webhook yüklerine dahil edilir. En fazla 50 anahtar, anahtar başına 100 karakter, değer başına 500 karakter. Ayrılmış custom_cta ve custom_cta_url anahtarları ayarlandığında, bu varyant için ürünün ödeme sayfası harekete geçirici ifadesini geçersiz kılar.
boolean | null
gerekli
İptal indirimi sunulup sunulmadığı. Aktör varyantın hesabında plan:basic:read kapsamına sahip değilse null.
object | null
gerekli
Ödeme yöntemi yapılandırması (enabled, disabled, include_platform_defaults); varyant varsayılan ayarları kullanıyorsa null.
object | null
gerekli
Bu varyantın ait olduğu ürün; bağımsız varyantlar için null.
string
gerekli
Müşterilerin bu varyantı doğrudan satın alabileceği URL.
string | null
gerekli
Müşterinin bu varyant için ödeme yaptıktan sonra yönlendirildiği yer. Ayarlanmamışsa veya aktör varyantın hesabında plan:basic:read kapsamına sahip değilse null.
string
gerekli
Bu varyantın satış yöntemi.Kullanılabilir seçenekler: buy_now, waitlist
number
gerekli
Her faturalandırma döneminde tahsil edilen, currency cinsinden yinelenen fiyat.
string | null
gerekli
Satıcı tarafından belirlenen serbest metin stok tutma birimi (ör. TSHIRT-LARGE-BLUE). Benzersizliği zorunlu değildir. Ayarlanmamışsa null.
number | null
gerekli
Abonelik duraklatılmadan önce gereken taksit ödemeleri. 1’den büyük olmalıdır. Bölünmüş ödeme yapılandırılmamışsa null.
number | null
gerekli
Satın alınabilecek adet. Aktör varyantın hesabında plan:basic:read kapsamına sahip değilse null.
number | null
gerekli
Üstü çizili olarak gösterilen, currency cinsinden orijinal ilk fiyat. Üstü çizili fiyat ayarlanmamışsa null.
number | null
gerekli
Üstü çizili olarak gösterilen, currency cinsinden orijinal yenileme fiyatı. Üstü çizili fiyat ayarlanmamışsa null.
string | null
gerekli
Desteklenen oturum içi kart ödemeleri için 3D Secure davranışı. mandate_challenge, ödeme işlenmeden önce bir 3DS doğrulaması gerektirir; mandate_if_required, yalnızca ödeme işlemcisi gerektirdiğinde doğrulamayı zorunlu kılar; frictionless_if_required, normal sürtünmesiz 3DS akışını kullanır. 1.000 $ veya üzeri ödemeler, mandate_challenge seçilmedikçe mandate_if_required kullanır. Risk ve kimlik doğrulama kurtarma gereksinimleri tercihi geçersiz kılabilir. null hesap varsayılanını devralır.Kullanılabilir seçenekler: mandate_challenge, mandate_if_required, frictionless_if_required
string | null
gerekli
Müşterilere gösterilen varyant görünen adı. En fazla 30 karakter. Başlıksız oluşturulan bir varyant varsayılan olarak / ile birleştirilmiş öznitelik değerlerini alır. Başlık ayarlanmamışsa null.
number | null
gerekli
İlk yenileme tahsilatından önceki ücretsiz deneme günleri. Deneme yapılandırılmamışsa veya kullanıcı bu varyant için zaten bir deneme kullanmışsa null.
boolean
gerekli
Varyantın sınırsız stoğa sahip olup olmadığı. true olduğunda stock alanı yok sayılır; bekleme listesi varyantları her zaman true bildirir.
string
gerekli
Varyantın en son güncellendiği zaman, ISO 8601 zaman damgası olarak.
string
gerekli
Bu varyantın nerede görülebileceğini kontrol eder. hidden olduğunda varyanta yalnızca doğrudan bağlantısıyla erişilebilir.Kullanılabilir seçenekler: visible, hidden, archived, quick_link
boolean
gerekli
Ürünün Whop tarafından doğrulanıp doğrulanmadığı.
string | null
gerekli
Ürünün herkese açık mı, gizli mi yoksa arşivlenmiş mi olduğu.
Product