Skip to main content
Tahsil edildiğinde pay_ kimliği aynı zamanda ödeme kimliğidir. Invoices API’yi taslakları oluşturmak ve düzenlemek, ardından bunları düzenlemek veya göndermek için kullanın. Açık bir faturayı kayıtlı bir ödeme yönteminden tahsil edebilir veya alıcının ödemeyeceği bir faturayı geçersiz kılabilirsiniz. Taslak oluşturma erişim oluşturmaz veya alıcıdan tahsilat yapmaz. Alıcının iletişim bilgileri hesabın üyesinde bulunur. Finansal alanlar ve çağıran meta verileri yalnızca taslak halindeyken düzenlenebilir.

Uç noktalar

Öznitelikler

string
gerekli
string
gerekli
object
gerekli

Ö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
Küçük harfli, üç harfli ISO 4217 para birimi kodu.
integer
gerekli
Tutarın kaç ondalık basamak taşıdığı. Bu, tahsilatın kendisinin işlendiği hassasiyettir.
integer
gerekli
Kaç ondalık basamağın GÖSTERİLECEĞİ. Genellikle decimals ile aynıdır ve 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 | null
gerekli

Özellikler

string | null
gerekli
Şehir.
string | null
gerekli
ISO 3166-1 alpha-2 ülke kodu.
string | null
gerekli
Birinci sokak adresi satırı.
string | null
gerekli
İkinci sokak adresi satırı.
string | null
gerekli
Adresteki ad.
string | null
gerekli
Posta veya ZIP kodu.
string | null
gerekli
Eyalet, il veya bölge.
object
gerekli

Ö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
Küçük harfli, üç harfli ISO 4217 para birimi kodu.
integer
gerekli
Tutarın kaç ondalık basamak taşıdığı. Bu, tahsilatın kendisinin işlendiği hassasiyettir.
integer
gerekli
Kaç ondalık basamağın GÖSTERİLECEĞİ. Genellikle decimals ile aynıdır ve 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.
number
gerekli
Alıcının ödeyebilmesi için bu faturayı bir ödeme oturumunda açan imzalı bir bağlantı. Bunu POST /checkout_sessions isteğine link olarak iletin. Fatura açıkken bulunur. Diğer tüm durumlarda, bir işletme alıcısına kesilen faturalarda ve üyeliği iptal edilmiş faturalarda null. Ayrıca payment:charge yetkiniz yoksa veya payment_method_id olmayan bir faturada invoice:create ya da invoice:update yetkiniz yoksa null.
string
gerekli
string | null
gerekli
boolean
gerekli
DELETE /invoices/\{id} bu faturayı silebildiğinde true. Bir taslak, zamanlanmış olmadığı veya bir aboneliği faturalandırmadığı sürece uygundur. Geçersiz kılınmış bir fatura, para tahsil etmediği veya hâlâ bir banka havalesi beklemediği sürece uygundur.
string | null
gerekli
string | null
gerekli
string | null
gerekli
object[]
gerekli

Özellikler

string | null
gerekli
li_ önekli kalem kimliği. Ödeme kalem anlık görüntülerinden önceye aitse ve kalem ödemenin varyantından okunuyorsa null.
string | null
gerekli
Faturada, e-postasında ve PDF’inde kalemin altında gösterilen, varyantın description alanından okunan metin. Özel bir tahsilat bunu kalemin description alanıyla ayarlar. Bir ürün varyantı kendi açıklamasını korur. Varyantın açıklaması yoksa veya varyant sonradan silinmişse null.
object | null
gerekli
Bu kaleme uygulanan promosyon indirimi, ödemenin currency biriminde. İndirim kaydedilmemişse null.

Ö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
Küçük harfli, üç harfli ISO 4217 para birimi kodu.
integer
gerekli
Tutarın kaç ondalık basamak taşıdığı. Bu, tahsilatın kendisinin işlendiği hassasiyettir.
integer
gerekli
Kaç ondalık basamağın GÖSTERİLECEĞİ. Genellikle decimals ile aynıdır ve 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 | null
gerekli
unit_amount tutarının, yinelenen bir varyantın yalnızca bu faturada tahsil edilen tek seferlik peşin ücreti (varyantın initial_price değeri) olan kısmı. unit_amount tutarının geri kalanı ilk faturalandırma dönemidir. Deneme süresinin ilk dönem tahsilatı yoktur. Tek seferlik kalemler, yenileme faturaları, peşin ücreti olmayan kalemler ve fatura fiyatlandırıldıktan sonra varyant fiyatları değişen kalemler için null.

Ö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
Küçük harfli, üç harfli ISO 4217 para birimi kodu.
integer
gerekli
Tutarın kaç ondalık basamak taşıdığı. Bu, tahsilatın kendisinin işlendiği hassasiyettir.
integer
gerekli
Kaç ondalık basamağın GÖSTERİLECEĞİ. Genellikle decimals ile aynıdır ve 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
Kalemin ödeme sayfasında gösterilen adı (ürün başlığı, yoksa varyant başlığı).
string | null
gerekli
Varyantın ait olduğu, prod_ önekli ürün. Ürünü olmayan bir varyant için null.
number
gerekli
Kaç birim satın alındığı.
object | null
gerekli
unit_amount çarpı quantity, indirimler ve vergiden önce, ödemenin currency biriminde.

Ö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
Küçük harfli, üç harfli ISO 4217 para birimi kodu.
integer
gerekli
Tutarın kaç ondalık basamak taşıdığı. Bu, tahsilatın kendisinin işlendiği hassasiyettir.
integer
gerekli
Kaç ondalık basamağın GÖSTERİLECEĞİ. Genellikle decimals ile aynıdır ve 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 | null
gerekli
Bu kalem için tahsil edilen vergi, ödemenin currency biriminde. Vergi kaydedilmemişse null.

Ö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
Küçük harfli, üç harfli ISO 4217 para birimi kodu.
integer
gerekli
Tutarın kaç ondalık basamak taşıdığı. Bu, tahsilatın kendisinin işlendiği hassasiyettir.
integer
gerekli
Kaç ondalık basamağın GÖSTERİLECEĞİ. Genellikle decimals ile aynıdır ve 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.
integer | null
gerekli
Bu yinelenen kalemin ilk yenileme tahsilatından önceki ücretsiz deneme günleri, varyantın trial_period_days alanından. Fatura bu durumda kalem için yalnızca varyantın initial_price tutarını faturalandırır. Tek seferlik kalemler ve yenileme faturaları için ve müşterinin varyanta zaten bir aboneliği varsa null.
object | null
gerekli
İndirimlerden önce bir birimin kaydedilmiş fiyatı, ödemenin currency biriminde. Yinelenen kalemler oluşturulurken veya değiştirilirken peşin ücret ve kalem bir denemeyle başlamıyorsa ilk faturalandırma dönemi dahil edilir. Yenileme faturaları peşin ücreti hariç tutar. Diğer düzenlemeler kaydedilmiş fiyatları korur. Ödeme fiyat kaydetmediyse null.

Ö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
Küçük harfli, üç harfli ISO 4217 para birimi kodu.
integer
gerekli
Tutarın kaç ondalık basamak taşıdığı. Bu, tahsilatın kendisinin işlendiği hassasiyettir.
integer
gerekli
Kaç ondalık basamağın GÖSTERİLECEĞİ. Genellikle decimals ile aynıdır ve 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
Satın alınan, plan_ önekli varyant. Varyant sonradan silinmişse null.
string | null
gerekli
string | null
gerekli
string | null
gerekli
Bu faturanın faturalandırdığı, mem_ önekli üyelik. Bir yenileme faturası için yenilenen aboneliktir. Yinelenen kalem içeren bir fatura için fatura düzenlendiğinde oluşturulan üyeliktir. Tek seferlik faturalar, henüz düzenlenmemiş bir taslak ve member:basic:read izni olmadan null.
string | null
gerekli
Müşteriye yönelik, fatura e-postasında, PDF’te ve ödeme sayfasında satır sonları korunarak gösterilen bir not. Ayarlanmamışsa null.
object
gerekli
string
gerekli
string
gerekli
boolean
gerekli
string | null
gerekli
object | null
gerekli
Müşterinin faturanın ödeme bağlantısı üzerinden öderken seçebileceği ödeme yöntemleri. Faturanın varyantlarına ve hesaba göre önceliklidir. Fatura varyantlarının ödeme yöntemlerini kullanıyorsa null.

Özellikler

string[]
gerekli
Varsayılanlar sunsa bile bu ödeme sayfasının sunmadığı ödeme yöntemleri.
string[]
gerekli
Bu ödeme sayfasının varsayılanların sağladıklarına ek olarak sunduğu ödeme yöntemleri.
boolean
gerekli
Whop’un varsayılan kümesinin başlangıç noktası olup olmadığı. false olduğunda yalnızca enabled sunulur.
string | null
gerekli
string[]
gerekli
Faturalandırılan müşteriden bağımsız fatura e-postası alıcıları.
string | null
gerekli
Faturanın kayıtlı ödeme yönteminden ne zaman tahsilat yapılacağı, ISO 8601 zaman damgası olarak. Faturanın gönderildiği veya düzenlendiği charge_at değeridir. Bu yoksa, payment_method_id içeren bir fatura vadesinden önce gönderildiğinde veya düzenlendiğinde due_at olur. Bir taslakta, zamanlanmış gönderiminin charge_at değeridir. Aksi halde, tahsilat başladığında ve fatura ödendiğinde, geçersiz kılındığında veya tahsil edilemez olduğunda null.
string | null
gerekli
Bir taslağın zamanlanmış gönderiminin tetiklendiğinde uyguladığı collection_method. Taslağın zamanlanmış gönderimi yoksa veya gönderim bu olmadan zamanlandıysa ve fatura düzenlendikten sonra null.Kullanılabilir seçenekler: charge_automatically, send_invoice
string | null
gerekli
boolean
gerekli
Bu taslağın due_at zamanı geldiğinde otomatik olarak düzenlenip düzenlenmeyeceği. Düzenlenmesi, payment_method_id yönteminden tahsilat yapar veya ödeme bağlantısını recipient_emails adreslerine e-postayla gönderir. Taslak olmayan bir fatura ve zamanlanmış gönderimi olan bir taslak için false. Taslağın gönderilmesi eksik alıcılar veya kullanılamayan bir ödeme bağlantısı nedeniyle başarısız olacaksa false. Son kaydedildiğinde gelecekte bir due_at değeri olmayan bir taslak için false. 2026-11-12T22:00:00Z öncesinde oluşturulmuş bir taslak için false.
string
gerekli
Kullanılabilir seçenekler: draft, open, authorized, paid, pending, uncollectible, unresolved, void
string | null
gerekli
Faturanın yinelenen kalemlerinin ilk faturalandırma döneminin başladığı zaman, ISO 8601 zaman damgası olarak. Yenilemeler bu andan itibaren sayılır. null, dönemi fatura ödendiğinde başlatır; o zamana kadar geçmiş bir zaman da aynısını yapar. Başlangıç tarihi olan bir fatura, varyantlarının ücretsiz deneme süresini atlar.
object
gerekli

Ö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
Küçük harfli, üç harfli ISO 4217 para birimi kodu.
integer
gerekli
Tutarın kaç ondalık basamak taşıdığı. Bu, tahsilatın kendisinin işlendiği hassasiyettir.
integer
gerekli
Kaç ondalık basamağın GÖSTERİLECEĞİ. Genellikle decimals ile aynıdır ve 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 | null
gerekli

Ö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
Küçük harfli, üç harfli ISO 4217 para birimi kodu.
integer
gerekli
Tutarın kaç ondalık basamak taşıdığı. Bu, tahsilatın kendisinin işlendiği hassasiyettir.
integer
gerekli
Kaç ondalık basamağın GÖSTERİLECEĞİ. Genellikle decimals ile aynıdır ve 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
gerekli
Faturanın e-postasındaki ve PDF’indeki tarihler için America/New_York gibi IANA saat dilimi. Ayarlanmamışsa UTC.
object
gerekli

Ö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
Küçük harfli, üç harfli ISO 4217 para birimi kodu.
integer
gerekli
Tutarın kaç ondalık basamak taşıdığı. Bu, tahsilatın kendisinin işlendiği hassasiyettir.
integer
gerekli
Kaç ondalık basamağın GÖSTERİLECEĞİ. Genellikle decimals ile aynıdır ve 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
gerekli
Kullanılabilir seçenekler: estimated, final
string
gerekli
Invoice