Skip to main content
Fiyatı, faturalandırma sıklığını, stoku, SKU’yu, öznitelikleri, vergi davranışını, ödeme alanlarını ve satın alma görünürlüğünü kontrol eder. Variant kimlikleri plan_ önekli olmaya devam eder. Variants API’yi ürünler için varyantlar oluşturmak, mevcut varyantları listelemek, varyant yapılandırmasını getirmek veya güncellemek, ödeme için vergi hesaplamak ve artık sunulmaması gereken varyantları silmek için kullanın.

Uç noktalar

Öznitelikler

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

Özellikler

string
gerekli
Hesap kimliği, biz_ önekli.
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 birimin satın alınıp alınamayacağı. Yenilenen varyantlar bunu etkinleştiremez. false olduğunda ödemeler, sepetler ve faturalar 1’in üzerindeki miktarları 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, örneğin \{"color": "Blue", "size": "Large"}. Adlar snake_case tanımlayıcılarıdır ve alfabetik sırayla döner. Bir üründeki öznitelikli her varyant aynı öznitelik adlarını ve farklı bir değer kümesini taşır; ürün tüm seçenek kümesini variant_attributes olarak listeler. Varyantın özniteliği olmadığında null.
number | null
gerekli
Yinelenen ücretler 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: süresiz için 0, yalnızca sonraki ödeme için 1 veya müşterinin kabul ettiği andan itibaren takvim ayı sayısı. Hiçbiri sunulmadığında veya aktör plan:basic:read kapsamına sahip olmadığında null.
number | null
gerekli
Tam sayı yüzde olarak iptal indirimi. Hiçbiri sunulmadığında veya aktör plan:basic:read kapsamına sahip olmadığında 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.
boolean
gerekli
Hesabın vergi yapılandırmasına göre bu varyantın satın alımlarında vergi tahsil edilip edilmediği.
string
gerekli
Varyantın oluşturulduğu zaman, ISO 8601 zaman damgası olarak.
string
gerekli
Bu varyanttaki her fiyatın belirtildiği para biriminin üç harfli ISO 4217 kodu, küçük harfli: 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
Özel alan kimliği, field_ önekli.
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
Ödeme formundaki alan konumu.
string | null
gerekli
Boş alanda gösterilen yer tutucu metin. Hiçbiri ayarlanmadıysa null.
boolean
gerekli
Müşterinin ödeme yapmak için bu alanı doldurması gerekip gerekmediği.
boolean | null
gerekli
Varyantın silinip silinemeyeceği (üyeliği veya bekleme listesi girişi yoksa). Aktör varyantın hesabında plan:basic:read kapsamına sahip olmadığı sürece null.
string | null
gerekli
Müşteriye görünen varyant açıklaması. En fazla 1000 karakter. Açıklama ayarlanmadıysa null.
object | null
gerekli
Bu varyant için bir ödemeyi yöneten, her katman (varyantın kendisi ve hesabınki) üzerinden çözümlenmiş yapılandırma — bir oturumun payment_method_configuration alanının taşıdığı yapı. Sunulabilir kümeyi elde etmek için bunu ödeme yöntemi türleri kataloğu üzerine uygulayın. null platform varsayılanları anlamına gelir; payment_method_configuration varyantın kendi düzenlenebilir geçersiz kılması olarak kalır.

Özellikler

string[]
gerekli
Varsayılanlar sunacak olsa bile bu ödemenin sunmadığı ödeme yöntemleri.
string[]
gerekli
Bu ödemenin, varsayılanların sağladıklarına ek olarak sunduğu ödeme yöntemleri.
boolean
gerekli
Başlangıç noktasının Whop’un varsayılan kümesi olup olmadığı. false olduğunda yalnızca enabled sunulur.
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österim için currency cinsinden insan tarafından okunabilir fiyat (para birimi + aralık), örneğin “$10 / month”.
object | null
gerekli
Ürün sayfasında gösterilen fiyatlandırma katmanı görseli (url, blurhash); görsel ayarlanmadığında null.
number
gerekli
currency cinsinden ilk satın alma fiyatı.
object
gerekli
Promosyon kodları ve vergiden önce bir birim 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 kullandıysa 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ı onu yuvarlamasın diye bir dizedir.
string
gerekli
Üç harfli ISO 4217 para birimi kodu, küçük harfli.
integer
gerekli
Tutarın taşıdığı ondalık basamak sayısı. Bu, ücretin kendisinin işlendiği hassasiyettir.
integer
gerekli
GÖSTERİLECEK ondalık basamak sayısı. Genellikle decimals ile aynıdır, ancak kasıtlı 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 olmadığı sürece 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 etkin üyelikler. Aktör varyantın hesabında plan:basic:read kapsamına sahip olmadığı sürece 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 harekete geçirici mesajını geçersiz kılar.
boolean | null
gerekli
İptal indirimi sunulup sunulmadığı. Aktör varyantın hesabında plan:basic:read kapsamına sahip olmadığı sürece null.
object | null
gerekli
Ödeme yöntemi yapılandırması (enabled, disabled, include_platform_defaults); varyant varsayılan ayarları kullandığında 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. Hiçbiri ayarlanmadığında veya aktör varyantın hesabında plan:basic:read kapsamına sahip olmadığı sürece 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 yinelenen fiyat, currency cinsinden.
string | null
gerekli
Stok tutma birimi, satıcı tarafından ayarlanan serbest metin (örneğin TSHIRT-LARGE-BLUE). Benzersizliği zorunlu değildir. Ayarlanmadığında 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ılmadıysa null.
number | null
gerekli
Satın alınabilir birimler. Aktör varyantın hesabında plan:basic:read kapsamına sahip olmadığı sürece null.
number | null
gerekli
Üstü çizili olarak gösterilen orijinal ilk fiyat, currency cinsinden. Üstü çizili fiyat ayarlanmadığında null.
number | null
gerekli
Üstü çizili olarak gösterilen orijinal yenileme fiyatı, currency cinsinden. Üstü çizili fiyat ayarlanmadığında null.
string
gerekli
Bu varyant için verginin nasıl işlendiği; verginin fiyata dahil mi, ödeme sırasında mı eklendiği yoksa yapılandırılmamış mı olduğu dahil.Kullanılabilir seçenekler: inclusive, exclusive, unspecified
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. mandate_challenge seçilmediği sürece 1.000 $ veya üzeri ödemeler mandate_if_required kullanır. Risk ve kimlik doğrulama kurtarma gereksinimleri bu 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. Ad olmadan oluşturulan bir varyant varsayılan olarak / ile birleştirilmiş öznitelik değerlerini kullanır. Başlık ayarlanmadıysa null.
number | null
gerekli
İlk yenileme ücretinden önceki ücretsiz deneme günleri. Deneme yapılandırılmadıysa veya kullanıcı bu varyant için zaten bir deneme kullandıysa 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.
integer | null
gerekli
Bu varyant için düzenlenmiş, ödenmemiş veya geçersiz kılınmamış fatura sayısı. 0’ın üzerinde olduğu sürece varyantın fiyatlarını, faturalandırma dönemini, denemesini, ödeme sayısını, para birimini veya faturalandırma türünü değiştiremezsiniz. Aktör varyantın hesabında plan:basic:read kapsamına sahip olmadığı sürece null.
string
gerekli
Varyantın 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
Variant