Skip to main content
De pay_-ID is ook de betalings-ID wanneer de factuur is geïnd. Gebruik de Invoices API om concepten aan te maken en te bewerken, en ze vervolgens uit te geven of te verzenden. Je kunt een openstaande factuur afschrijven van een opgeslagen betaalmethode, of een factuur die de koper niet zal betalen ongeldig maken. Het aanmaken van een concept creëert geen toegang en schrijft niets af bij de koper. De contactgegevens van de ontvanger staan bij het lid van het account. Financiële velden en metadata van de aanroeper kunnen alleen in concept worden bewerkt.

Endpoints

Attributen

string
vereist
string
vereist
object
vereist

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen enkele float het onderweg afrondt.
string
vereist
Valutacode van drie letters volgens ISO 4217, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de afschrijving zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen er moeten worden WEERGEGEVEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt afgeschreven in centavos maar geschreven in hele peso’s, dus het is 2 en 0. Formatteer het getal hiermee in je eigen landinstelling.
object | null
vereist

Eigenschappen

string | null
vereist
De plaats.
string | null
vereist
De ISO 3166-1 alpha-2-landcode.
string | null
vereist
De eerste adresregel.
string | null
vereist
De tweede adresregel.
string | null
vereist
De naam op het adres.
string | null
vereist
De postcode.
string | null
vereist
De staat, provincie of regio.
object
vereist

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen enkele float het onderweg afrondt.
string
vereist
Valutacode van drie letters volgens ISO 4217, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de afschrijving zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen er moeten worden WEERGEGEVEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt afgeschreven in centavos maar geschreven in hele peso’s, dus het is 2 en 0. Formatteer het getal hiermee in je eigen landinstelling.
number
vereist
Een ondertekende link die deze factuur opent in een checkoutsessie zodat de koper kan betalen. Geef deze mee als link aan POST /checkout_sessions. Aanwezig zolang de factuur open is. null bij elke andere status, voor een factuur die aan een zakelijke koper is gericht, en voor een factuur waarvan het lidmaatschap is geannuleerd. Ook null tenzij je payment:charge hebt, of invoice:create of invoice:update op een factuur zonder payment_method_id.
string
vereist
string | null
vereist
boolean
vereist
True wanneer DELETE /invoices/\{id} deze factuur kan verwijderen. Een concept komt in aanmerking tenzij het is ingepland of een abonnement factureert. Een ongeldige factuur komt in aanmerking tenzij er geld mee is geïnd of er nog op een bankoverschrijving wordt gewacht.
string | null
vereist
string | null
vereist
string | null
vereist
object[]
vereist

Eigenschappen

string | null
vereist
ID van de factuurregel, met voorvoegsel li_. Null wanneer de betaling dateert van vóór de momentopnamen van items en het item wordt gelezen uit de variant van de betaling.
string | null
vereist
Tekst die onder het item wordt getoond op de factuur, de e-mail en de pdf ervan, gelezen uit de description van de variant. Een aangepaste afschrijving stelt deze in met de description van het item. Een productvariant behoudt de eigen tekst. Null wanneer de variant er geen heeft of inmiddels is verwijderd.
object | null
vereist
De promotiekorting die op dit item is toegepast, in de currency van de betaling. Null wanneer er geen korting is vastgelegd.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen enkele float het onderweg afrondt.
string
vereist
Valutacode van drie letters volgens ISO 4217, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de afschrijving zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen er moeten worden WEERGEGEVEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt afgeschreven in centavos maar geschreven in hele peso’s, dus het is 2 en 0. Formatteer het getal hiermee in je eigen landinstelling.
object | null
vereist
Het deel van unit_amount dat de eenmalige vooruitbetaling van een terugkerende variant is, de initial_price van de variant, die alleen op deze factuur wordt afgeschreven. De rest van unit_amount is de eerste factureringsperiode. Een proefperiode heeft geen afschrijving voor de eerste periode. Null voor eenmalige items, verlengingsfacturen, items zonder vooruitbetaling en items waarvan de variantprijzen zijn gewijzigd nadat de factuur was geprijsd.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen enkele float het onderweg afrondt.
string
vereist
Valutacode van drie letters volgens ISO 4217, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de afschrijving zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen er moeten worden WEERGEGEVEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt afgeschreven in centavos maar geschreven in hele peso’s, dus het is 2 en 0. Formatteer het getal hiermee in je eigen landinstelling.
string | null
vereist
De naam van het item zoals getoond bij checkout (de producttitel, anders de varianttitel).
string | null
vereist
Het product waartoe de variant behoort, met voorvoegsel prod_. Null voor een variant zonder product.
number
vereist
Hoeveel eenheden er zijn gekocht.
object | null
vereist
unit_amount maal quantity, vóór kortingen en belasting, in de currency van de betaling.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen enkele float het onderweg afrondt.
string
vereist
Valutacode van drie letters volgens ISO 4217, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de afschrijving zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen er moeten worden WEERGEGEVEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt afgeschreven in centavos maar geschreven in hele peso’s, dus het is 2 en 0. Formatteer het getal hiermee in je eigen landinstelling.
object | null
vereist
De belasting die op dit item is geïnd, in de currency van de betaling. Null wanneer er geen belasting is vastgelegd.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen enkele float het onderweg afrondt.
string
vereist
Valutacode van drie letters volgens ISO 4217, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de afschrijving zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen er moeten worden WEERGEGEVEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt afgeschreven in centavos maar geschreven in hele peso’s, dus het is 2 en 0. Formatteer het getal hiermee in je eigen landinstelling.
integer | null
vereist
Gratis proefdagen vóór de eerste verlengingsafschrijving van dit terugkerende item, uit de trial_period_days van de variant. De factuur rekent dan alleen de initial_price van de variant voor het item. null voor eenmalige items en verlengingsfacturen, en wanneer de klant al een abonnement op de variant had.
object | null
vereist
De opgeslagen prijs van één eenheid vóór kortingen, in de currency van de betaling. Bij het aanmaken of vervangen van terugkerende items is de vooruitbetaling inbegrepen, plus de eerste factureringsperiode tenzij het item met een proefperiode begint. Verlengingsfacturen sluiten de vooruitbetaling uit. Andere bewerkingen behouden opgeslagen prijzen. Null wanneer de betaling geen prijs heeft vastgelegd.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen enkele float het onderweg afrondt.
string
vereist
Valutacode van drie letters volgens ISO 4217, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de afschrijving zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen er moeten worden WEERGEGEVEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt afgeschreven in centavos maar geschreven in hele peso’s, dus het is 2 en 0. Formatteer het getal hiermee in je eigen landinstelling.
string | null
vereist
De gekochte variant, met voorvoegsel plan_. Null wanneer de variant inmiddels is verwijderd.
string | null
vereist
string | null
vereist
string | null
vereist
Het lidmaatschap dat deze factuur factureert, met voorvoegsel mem_. Voor een verlengingsfactuur is dit het abonnement dat wordt verlengd. Voor een factuur met een terugkerend item is dit het lidmaatschap dat wordt aangemaakt wanneer de factuur wordt uitgegeven. Null voor eenmalige facturen, voor een concept dat nog niet is uitgegeven, en zonder de machtiging member:basic:read.
string | null
vereist
Een notitie voor de klant, getoond in de factuur-e-mail, de pdf en de checkoutpagina met behoud van regeleinden. null wanneer er geen is ingesteld.
object
vereist
string
vereist
string
vereist
boolean
vereist
string | null
vereist
object | null
vereist
De betaalmethoden waaruit de klant kan kiezen bij betalen via de checkoutlink van de factuur. Dit heeft voorrang op de varianten van de factuur en het account. null wanneer de factuur de betaalmethoden van de varianten gebruikt.

Eigenschappen

string[]
vereist
Betaalmethoden die deze checkout achterhoudt, zelfs wanneer de standaardinstellingen ze zouden aanbieden.
string[]
vereist
Betaalmethoden die deze checkout aanbiedt bovenop wat de standaardinstellingen bieden.
boolean
vereist
Of de standaardset van Whop het uitgangspunt is. Bij false wordt alleen enabled aangeboden.
string | null
vereist
string[]
vereist
Ontvangers van de factuur-e-mail, onafhankelijk van de gefactureerde klant.
string | null
vereist
Wanneer de opgeslagen betaalmethode van de factuur wordt belast, als ISO 8601-tijdstempel. Het is de charge_at waarmee de factuur is verzonden of uitgegeven. Zonder die waarde is het due_at wanneer een factuur met een payment_method_id wordt verzonden of uitgegeven vóór de vervaldatum. Bij een concept is het de charge_at van de geplande verzending. Anders null, zodra de afschrijving begint, en zodra de factuur is betaald, ongeldig of oninbaar is.
string | null
vereist
De collection_method die de geplande verzending van een concept toepast wanneer deze wordt uitgevoerd. null wanneer het concept geen geplande verzending heeft of zonder deze waarde is ingepland, en zodra de factuur is uitgegeven.Beschikbare opties: charge_automatically, send_invoice
string | null
vereist
boolean
vereist
Of dit concept automatisch wordt uitgegeven wanneer de due_at is bereikt. Bij uitgifte wordt de payment_method_id belast, of wordt de betaallink gemaild naar de recipient_emails. false voor een factuur die geen concept is en voor een concept met een geplande verzending. false zolang het verzenden van het concept zou mislukken door ontbrekende ontvangers of een niet-beschikbare betaallink. false voor een concept dat geen toekomstige due_at had toen het voor het laatst werd opgeslagen. false voor een concept dat vóór 2026-11-12T22:00:00Z is aangemaakt.
string
vereist
Beschikbare opties: draft, open, authorized, paid, pending, uncollectible, unresolved, void
string | null
vereist
Wanneer de eerste factureringsperiode van de terugkerende items van de factuur begint, als ISO 8601-tijdstempel. Verlengingen tellen vanaf dit moment. null laat de periode beginnen wanneer de factuur wordt betaald, en dat geldt ook voor een tijdstip dat dan al is verstreken. Een factuur met een startdatum slaat de gratis proefperiode van de varianten over.
object
vereist

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen enkele float het onderweg afrondt.
string
vereist
Valutacode van drie letters volgens ISO 4217, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de afschrijving zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen er moeten worden WEERGEGEVEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt afgeschreven in centavos maar geschreven in hele peso’s, dus het is 2 en 0. Formatteer het getal hiermee in je eigen landinstelling.
object | null
vereist

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen enkele float het onderweg afrondt.
string
vereist
Valutacode van drie letters volgens ISO 4217, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de afschrijving zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen er moeten worden WEERGEGEVEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt afgeschreven in centavos maar geschreven in hele peso’s, dus het is 2 en 0. Formatteer het getal hiermee in je eigen landinstelling.
string
vereist
De IANA-tijdzone voor de datums in de e-mail en pdf van de factuur, zoals America/New_York. UTC tenzij er een is ingesteld.
object
vereist

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen enkele float het onderweg afrondt.
string
vereist
Valutacode van drie letters volgens ISO 4217, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de afschrijving zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen er moeten worden WEERGEGEVEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt afgeschreven in centavos maar geschreven in hele peso’s, dus het is 2 en 0. Formatteer het getal hiermee in je eigen landinstelling.
string
vereist
Beschikbare opties: estimated, final
string
vereist
Invoice