Skip to main content
Dens pay_-ID er også betalings-ID’et, når den opkræves. Brug Invoices-API’et til at oprette og redigere kladder og derefter udstede eller sende dem. Du kan opkræve en åben faktura via en gemt betalingsmetode eller annullere en faktura, som køberen ikke vil betale. Oprettelse af en kladde opretter ikke adgang og opkræver ikke køberen. Modtagerens kontaktoplysninger ligger på kontoens medlem. Finansielle felter og kalderens metadata kan kun redigeres i kladdetilstand.

Endpoints

Attributter

string
påkrævet
string
påkrævet
object
påkrævet

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en eksakt decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
string
påkrævet
Trebogstavs ISO 4217-valutakode med små bogstaver.
integer
påkrævet
Hvor mange decimaler beløbet har. Dette er den præcision, som selve opkrævningen kører med.
integer
påkrævet
Hvor mange decimaler der skal VISES. Normalt lig med decimals, og bevidst ikke altid: COP opkræves i centavos, men skrives i hele pesos, så det er 2 og 0. Brug dette til at formatere tallet i din egen locale.
object | null
påkrævet

Egenskaber

string | null
påkrævet
Byen.
string | null
påkrævet
ISO 3166-1 alpha-2-landekoden.
string | null
påkrævet
Den første adresselinje.
string | null
påkrævet
Den anden adresselinje.
string | null
påkrævet
Navnet på adressen.
string | null
påkrævet
Postnummeret.
string | null
påkrævet
Staten, provinsen eller regionen.
object
påkrævet

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en eksakt decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
string
påkrævet
Trebogstavs ISO 4217-valutakode med små bogstaver.
integer
påkrævet
Hvor mange decimaler beløbet har. Dette er den præcision, som selve opkrævningen kører med.
integer
påkrævet
Hvor mange decimaler der skal VISES. Normalt lig med decimals, og bevidst ikke altid: COP opkræves i centavos, men skrives i hele pesos, så det er 2 og 0. Brug dette til at formatere tallet i din egen locale.
number
påkrævet
Et signeret link, der åbner denne faktura i en checkout-session, så køberen kan betale den. Send det som link til POST /checkout_sessions. Til stede, mens fakturaen er åben. null i enhver anden status, for en faktura udstedt til en erhvervskøber og for en faktura, hvis medlemskab er annulleret. Også null, medmindre du har payment:charge, eller invoice:create eller invoice:update på en faktura uden payment_method_id.
string
påkrævet
string | null
påkrævet
boolean
påkrævet
True, når DELETE /invoices/\{id} kan slette denne faktura. En kladde opfylder kravet, medmindre den er planlagt eller fakturerer et abonnement. En annulleret faktura opfylder kravet, medmindre den har indsamlet penge eller stadig afventer en bankoverførsel.
string | null
påkrævet
string | null
påkrævet
string | null
påkrævet
object[]
påkrævet

Egenskaber

string | null
påkrævet
Linjeelement-ID, med præfikset li_. Null, når betalingen går forud for element-snapshots, og elementet læses fra betalingens variant.
string | null
påkrævet
Tekst vist under elementet på fakturaen, dens e-mail og dens PDF, læst fra variantens description. En brugerdefineret opkrævning angiver den med elementets description. En produktvariant beholder sin egen. Null, når varianten ikke har nogen eller siden er blevet slettet.
object | null
påkrævet
Den kampagnerabat, der er anvendt på dette element, i betalingens currency. Null, når der ikke er registreret nogen rabat.

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en eksakt decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
string
påkrævet
Trebogstavs ISO 4217-valutakode med små bogstaver.
integer
påkrævet
Hvor mange decimaler beløbet har. Dette er den præcision, som selve opkrævningen kører med.
integer
påkrævet
Hvor mange decimaler der skal VISES. Normalt lig med decimals, og bevidst ikke altid: COP opkræves i centavos, men skrives i hele pesos, så det er 2 og 0. Brug dette til at formatere tallet i din egen locale.
object | null
påkrævet
Den del af unit_amount, der er en tilbagevendende variants engangsgebyr på forhånd, variantens initial_price, som kun opkræves på denne faktura. Resten af unit_amount er den første faktureringsperiode. En prøveperiode har ingen opkrævning for den første periode. Null for engangselementer, fornyelsesfakturaer, elementer uden forudgående gebyr og elementer, hvis variantpriser er ændret, efter at fakturaen blev prissat.

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en eksakt decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
string
påkrævet
Trebogstavs ISO 4217-valutakode med små bogstaver.
integer
påkrævet
Hvor mange decimaler beløbet har. Dette er den præcision, som selve opkrævningen kører med.
integer
påkrævet
Hvor mange decimaler der skal VISES. Normalt lig med decimals, og bevidst ikke altid: COP opkræves i centavos, men skrives i hele pesos, så det er 2 og 0. Brug dette til at formatere tallet i din egen locale.
string | null
påkrævet
Elementets navn, som det vises ved checkout (produkttitlen, ellers variantens titel).
string | null
påkrævet
Det produkt, varianten tilhører, med præfikset prod_. Null for en variant uden produkt.
number
påkrævet
Hvor mange enheder der blev købt.
object | null
påkrævet
unit_amount gange quantity, før rabatter og moms, i betalingens currency.

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en eksakt decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
string
påkrævet
Trebogstavs ISO 4217-valutakode med små bogstaver.
integer
påkrævet
Hvor mange decimaler beløbet har. Dette er den præcision, som selve opkrævningen kører med.
integer
påkrævet
Hvor mange decimaler der skal VISES. Normalt lig med decimals, og bevidst ikke altid: COP opkræves i centavos, men skrives i hele pesos, så det er 2 og 0. Brug dette til at formatere tallet i din egen locale.
object | null
påkrævet
Den moms, der er opkrævet på dette element, i betalingens currency. Null, når der ikke er registreret nogen moms.

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en eksakt decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
string
påkrævet
Trebogstavs ISO 4217-valutakode med små bogstaver.
integer
påkrævet
Hvor mange decimaler beløbet har. Dette er den præcision, som selve opkrævningen kører med.
integer
påkrævet
Hvor mange decimaler der skal VISES. Normalt lig med decimals, og bevidst ikke altid: COP opkræves i centavos, men skrives i hele pesos, så det er 2 og 0. Brug dette til at formatere tallet i din egen locale.
integer | null
påkrævet
Gratis prøvedage før dette tilbagevendende elements første fornyelsesopkrævning, fra variantens trial_period_days. Fakturaen opkræver derefter kun variantens initial_price for elementet. null for engangselementer og fornyelsesfakturaer, og når kunden allerede havde et abonnement på varianten.
object | null
påkrævet
Den gemte pris for én enhed før rabatter, i betalingens currency. Oprettelse eller udskiftning af tilbagevendende elementer inkluderer det forudgående gebyr plus den første faktureringsperiode, medmindre elementet starter med en prøveperiode. Fornyelsesfakturaer udelader det forudgående gebyr. Andre redigeringer bevarer gemte priser. Null, når betalingen ikke registrerede nogen pris.

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en eksakt decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
string
påkrævet
Trebogstavs ISO 4217-valutakode med små bogstaver.
integer
påkrævet
Hvor mange decimaler beløbet har. Dette er den præcision, som selve opkrævningen kører med.
integer
påkrævet
Hvor mange decimaler der skal VISES. Normalt lig med decimals, og bevidst ikke altid: COP opkræves i centavos, men skrives i hele pesos, så det er 2 og 0. Brug dette til at formatere tallet i din egen locale.
string | null
påkrævet
Den købte variant, med præfikset plan_. Null, når varianten siden er blevet slettet.
string | null
påkrævet
string | null
påkrævet
string | null
påkrævet
Det medlemskab, denne faktura fakturerer, med præfikset mem_. For en fornyelsesfaktura er det det abonnement, der fornyes. For en faktura med et tilbagevendende element er det det medlemskab, der oprettes, når fakturaen udstedes. Null for enkeltstående fakturaer, for en kladde, der endnu ikke er udstedt, og uden tilladelsen member:basic:read.
string | null
påkrævet
En note til kunden, vist i fakturaens e-mail, PDF og på checkout-siden med linjeskift bevaret. null, når ingen er angivet.
object
påkrævet
string
påkrævet
string
påkrævet
boolean
påkrævet
string | null
påkrævet
object | null
påkrævet
De betalingsmetoder, kunden kan vælge imellem, når der betales via fakturaens checkout-link. Den har forrang for fakturaens varianter og kontoen. null, når fakturaen bruger sine varianters betalingsmetoder.

Egenskaber

string[]
påkrævet
Betalingsmetoder, som denne checkout tilbageholder, selv når standardindstillingerne ville tilbyde dem.
string[]
påkrævet
Betalingsmetoder, som denne checkout tilbyder ud over det, standardindstillingerne giver.
boolean
påkrævet
Om Whops standardsæt er udgangspunktet. Når false, tilbydes kun enabled.
string | null
påkrævet
string[]
påkrævet
Modtagere af faktura-e-mails, uafhængigt af den fakturerede kunde.
string | null
påkrævet
Hvornår fakturaens gemte betalingsmetode vil blive opkrævet, som et ISO 8601- tidsstempel. Det er den charge_at, fakturaen blev sendt eller udstedt med. Uden en sådan er det due_at, når en faktura med en payment_method_id sendes eller udstedes, før den forfalder. På en kladde er det charge_at for dens planlagte afsendelse. Ellers null, når opkrævningen starter, og når fakturaen er betalt, annulleret eller uinddrivelig.
string | null
påkrævet
Den collection_method, som en kladdes planlagte afsendelse anvender, når den udføres. null, når kladden ikke har nogen planlagt afsendelse, eller den blev planlagt uden en, og når fakturaen er udstedt.Tilgængelige muligheder: charge_automatically, send_invoice
string | null
påkrævet
boolean
påkrævet
Om denne kladde udstedes automatisk, når dens due_at indtræffer. Udstedelse opkræver dens payment_method_id eller e-mailer dens betalingslink til dens recipient_emails. false for en faktura, der ikke er en kladde, og for en kladde med en planlagt afsendelse. false, mens afsendelse af kladden ville mislykkes på grund af manglende modtagere eller et utilgængeligt betalingslink. false for en kladde, der ikke havde nogen fremtidig due_at, da den sidst blev gemt. false for en kladde oprettet før 2026-11-12T22:00:00Z.
string
påkrævet
Tilgængelige muligheder: draft, open, authorized, paid, pending, uncollectible, unresolved, void
string | null
påkrævet
Hvornår den første faktureringsperiode for fakturaens tilbagevendende elementer starter, som et ISO 8601-tidsstempel. Fornyelser regnes fra dette tidspunkt. null starter perioden, når fakturaen betales, og det samme gør et tidspunkt, der er passeret på det tidspunkt. En faktura med en startdato springer sine varianters gratis prøveperiode over.
object
påkrævet

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en eksakt decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
string
påkrævet
Trebogstavs ISO 4217-valutakode med små bogstaver.
integer
påkrævet
Hvor mange decimaler beløbet har. Dette er den præcision, som selve opkrævningen kører med.
integer
påkrævet
Hvor mange decimaler der skal VISES. Normalt lig med decimals, og bevidst ikke altid: COP opkræves i centavos, men skrives i hele pesos, så det er 2 og 0. Brug dette til at formatere tallet i din egen locale.
object | null
påkrævet

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en eksakt decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
string
påkrævet
Trebogstavs ISO 4217-valutakode med små bogstaver.
integer
påkrævet
Hvor mange decimaler beløbet har. Dette er den præcision, som selve opkrævningen kører med.
integer
påkrævet
Hvor mange decimaler der skal VISES. Normalt lig med decimals, og bevidst ikke altid: COP opkræves i centavos, men skrives i hele pesos, så det er 2 og 0. Brug dette til at formatere tallet i din egen locale.
string
påkrævet
IANA-tidszonen for datoerne i fakturaens e-mail og PDF, såsom America/New_York. UTC, medmindre en er angivet.
object
påkrævet

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en eksakt decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
string
påkrævet
Trebogstavs ISO 4217-valutakode med små bogstaver.
integer
påkrævet
Hvor mange decimaler beløbet har. Dette er den præcision, som selve opkrævningen kører med.
integer
påkrævet
Hvor mange decimaler der skal VISES. Normalt lig med decimals, og bevidst ikke altid: COP opkræves i centavos, men skrives i hele pesos, så det er 2 og 0. Brug dette til at formatere tallet i din egen locale.
string
påkrævet
Tilgængelige muligheder: estimated, final
string
påkrævet
Invoice