1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from typing import Optional, cast
from importlib import import_module
from typing_extensions import TYPE_CHECKING
if TYPE_CHECKING:
from stripe._invoice import Invoice
from stripe._invoice_line_item_service import InvoiceLineItemService
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe._search_result_object import SearchResultObject
from stripe.params._invoice_add_lines_params import InvoiceAddLinesParams
from stripe.params._invoice_attach_payment_params import (
InvoiceAttachPaymentParams,
)
from stripe.params._invoice_create_params import InvoiceCreateParams
from stripe.params._invoice_create_preview_params import (
InvoiceCreatePreviewParams,
)
from stripe.params._invoice_delete_params import InvoiceDeleteParams
from stripe.params._invoice_finalize_invoice_params import (
InvoiceFinalizeInvoiceParams,
)
from stripe.params._invoice_list_params import InvoiceListParams
from stripe.params._invoice_mark_uncollectible_params import (
InvoiceMarkUncollectibleParams,
)
from stripe.params._invoice_pay_params import InvoicePayParams
from stripe.params._invoice_remove_lines_params import (
InvoiceRemoveLinesParams,
)
from stripe.params._invoice_retrieve_params import InvoiceRetrieveParams
from stripe.params._invoice_search_params import InvoiceSearchParams
from stripe.params._invoice_send_invoice_params import (
InvoiceSendInvoiceParams,
)
from stripe.params._invoice_update_lines_params import (
InvoiceUpdateLinesParams,
)
from stripe.params._invoice_update_params import InvoiceUpdateParams
from stripe.params._invoice_void_invoice_params import (
InvoiceVoidInvoiceParams,
)
_subservices = {
"line_items": [
"stripe._invoice_line_item_service",
"InvoiceLineItemService",
],
}
class InvoiceService(StripeService):
line_items: "InvoiceLineItemService"
def __init__(self, requestor):
super().__init__(requestor)
def __getattr__(self, name):
try:
import_from, service = _subservices[name]
service_class = getattr(
import_module(import_from),
service,
)
setattr(
self,
name,
service_class(self._requestor),
)
return getattr(self, name)
except KeyError:
raise AttributeError()
def delete(
self,
invoice: str,
params: Optional["InvoiceDeleteParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Invoice":
"""
Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be [voided](https://docs.stripe.com/api#void_invoice).
"""
return cast(
"Invoice",
self._request(
"delete",
"/v1/invoices/{invoice}".format(invoice=sanitize_id(invoice)),
base_address="api",
params=params,
options=options,
),
)
async def delete_async(
self,
invoice: str,
params: Optional["InvoiceDeleteParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Invoice":
"""
Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be [voided](https://docs.stripe.com/api#void_invoice).
"""
return cast(
"Invoice",
await self._request_async(
"delete",
"/v1/invoices/{invoice}".format(invoice=sanitize_id(invoice)),
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
invoice: str,
params: Optional["InvoiceRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Invoice":
"""
Retrieves the invoice with the given ID.
"""
return cast(
"Invoice",
self._request(
"get",
"/v1/invoices/{invoice}".format(invoice=sanitize_id(invoice)),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
invoice: str,
params: Optional["InvoiceRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Invoice":
"""
Retrieves the invoice with the given ID.
"""
return cast(
"Invoice",
await self._request_async(
"get",
"/v1/invoices/{invoice}".format(invoice=sanitize_id(invoice)),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
invoice: str,
params: Optional["InvoiceUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Invoice":
"""
Draft invoices are fully editable. Once an invoice is [finalized](https://docs.stripe.com/docs/billing/invoices/workflow#finalized),
monetary values, as well as collection_method, become uneditable.
If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on,
sending reminders for, or [automatically reconciling](https://docs.stripe.com/docs/billing/invoices/reconciliation) invoices, pass
auto_advance=false.
"""
return cast(
"Invoice",
self._request(
"post",
"/v1/invoices/{invoice}".format(invoice=sanitize_id(invoice)),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
invoice: str,
params: Optional["InvoiceUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Invoice":
"""
Draft invoices are fully editable. Once an invoice is [finalized](https://docs.stripe.com/docs/billing/invoices/workflow#finalized),
monetary values, as well as collection_method, become uneditable.
If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on,
sending reminders for, or [automatically reconciling](https://docs.stripe.com/docs/billing/invoices/reconciliation) invoices, pass
auto_advance=false.
"""
return cast(
"Invoice",
await self._request_async(
"post",
"/v1/invoices/{invoice}".format(invoice=sanitize_id(invoice)),
base_address="api",
params=params,
options=options,
),
)
def list(
self,
params: Optional["InvoiceListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Invoice]":
"""
You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.
"""
return cast(
"ListObject[Invoice]",
self._request(
"get",
"/v1/invoices",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: Optional["InvoiceListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Invoice]":
"""
You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.
"""
return cast(
"ListObject[Invoice]",
await self._request_async(
"get",
"/v1/invoices",
base_address="api",
params=params,
options=options,
),
)
def create(
self,
params: Optional["InvoiceCreateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Invoice":
"""
This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you [finalize the invoice, which allows you to [pay](#pay_invoice) or <a href="#send_invoice">send](https://docs.stripe.com/api#finalize_invoice) the invoice to your customers.
"""
return cast(
"Invoice",
self._request(
"post",
"/v1/invoices",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: Optional["InvoiceCreateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Invoice":
"""
This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you [finalize the invoice, which allows you to [pay](#pay_invoice) or <a href="#send_invoice">send](https://docs.stripe.com/api#finalize_invoice) the invoice to your customers.
"""
return cast(
"Invoice",
await self._request_async(
"post",
"/v1/invoices",
base_address="api",
params=params,
options=options,
),
)
def search(
self,
params: "InvoiceSearchParams",
options: Optional["RequestOptions"] = None,
) -> "SearchResultObject[Invoice]":
"""
Search for invoices you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language).
Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
to an hour behind during outages. Search functionality is not available to merchants in India.
"""
return cast(
"SearchResultObject[Invoice]",
self._request(
"get",
"/v1/invoices/search",
base_address="api",
params=params,
options=options,
),
)
async def search_async(
self,
params: "InvoiceSearchParams",
options: Optional["RequestOptions"] = None,
) -> "SearchResultObject[Invoice]":
"""
Search for invoices you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language).
Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
to an hour behind during outages. Search functionality is not available to merchants in India.
"""
return cast(
"SearchResultObject[Invoice]",
await self._request_async(
"get",
"/v1/invoices/search",
base_address="api",
params=params,
options=options,
),
)
def add_lines(
self,
invoice: str,
params: "InvoiceAddLinesParams",
options: Optional["RequestOptions"] = None,
) -> "Invoice":
"""
Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.
"""
return cast(
"Invoice",
self._request(
"post",
"/v1/invoices/{invoice}/add_lines".format(
invoice=sanitize_id(invoice),
),
base_address="api",
params=params,
options=options,
),
)
async def add_lines_async(
self,
invoice: str,
params: "InvoiceAddLinesParams",
options: Optional["RequestOptions"] = None,
) -> "Invoice":
"""
Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.
"""
return cast(
"Invoice",
await self._request_async(
"post",
"/v1/invoices/{invoice}/add_lines".format(
invoice=sanitize_id(invoice),
),
base_address="api",
params=params,
options=options,
),
)
def attach_payment(
self,
invoice: str,
params: Optional["InvoiceAttachPaymentParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Invoice":
"""
Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments.
For the PaymentIntent, when the PaymentIntent's status changes to succeeded, the payment is credited
to the invoice, increasing its amount_paid. When the invoice is fully paid, the
invoice's status becomes paid.
If the PaymentIntent's status is already succeeded when it's attached, it's
credited to the invoice immediately.
See: [Partial payments](https://docs.stripe.com/docs/invoicing/partial-payments) to learn more.
"""
return cast(
"Invoice",
self._request(
"post",
"/v1/invoices/{invoice}/attach_payment".format(
invoice=sanitize_id(invoice),
),
base_address="api",
params=params,
options=options,
),
)
async def attach_payment_async(
self,
invoice: str,
params: Optional["InvoiceAttachPaymentParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Invoice":
"""
Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments.
For the PaymentIntent, when the PaymentIntent's status changes to succeeded, the payment is credited
to the invoice, increasing its amount_paid. When the invoice is fully paid, the
invoice's status becomes paid.
If the PaymentIntent's status is already succeeded when it's attached, it's
credited to the invoice immediately.
See: [Partial payments](https://docs.stripe.com/docs/invoicing/partial-payments) to learn more.
"""
return cast(
"Invoice",
await self._request_async(
"post",
"/v1/invoices/{invoice}/attach_payment".format(
invoice=sanitize_id(invoice),
),
base_address="api",
params=params,
options=options,
),
)
def finalize_invoice(
self,
invoice: str,
params: Optional["InvoiceFinalizeInvoiceParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Invoice":
"""
Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you'd like to finalize a draft invoice manually, you can do so using this method.
"""
return cast(
"Invoice",
self._request(
"post",
"/v1/invoices/{invoice}/finalize".format(
invoice=sanitize_id(invoice),
),
base_address="api",
params=params,
options=options,
),
)
async def finalize_invoice_async(
self,
invoice: str,
params: Optional["InvoiceFinalizeInvoiceParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Invoice":
"""
Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you'd like to finalize a draft invoice manually, you can do so using this method.
"""
return cast(
"Invoice",
await self._request_async(
"post",
"/v1/invoices/{invoice}/finalize".format(
invoice=sanitize_id(invoice),
),
base_address="api",
params=params,
options=options,
),
)
def mark_uncollectible(
self,
invoice: str,
params: Optional["InvoiceMarkUncollectibleParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Invoice":
"""
Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.
"""
return cast(
"Invoice",
self._request(
"post",
"/v1/invoices/{invoice}/mark_uncollectible".format(
invoice=sanitize_id(invoice),
),
base_address="api",
params=params,
options=options,
),
)
async def mark_uncollectible_async(
self,
invoice: str,
params: Optional["InvoiceMarkUncollectibleParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Invoice":
"""
Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.
"""
return cast(
"Invoice",
await self._request_async(
"post",
"/v1/invoices/{invoice}/mark_uncollectible".format(
invoice=sanitize_id(invoice),
),
base_address="api",
params=params,
options=options,
),
)
def pay(
self,
invoice: str,
params: Optional["InvoicePayParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Invoice":
"""
Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your [subscriptions settings](https://dashboard.stripe.com/account/billing/automatic). However, if you'd like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.
"""
return cast(
"Invoice",
self._request(
"post",
"/v1/invoices/{invoice}/pay".format(
invoice=sanitize_id(invoice),
),
base_address="api",
params=params,
options=options,
),
)
async def pay_async(
self,
invoice: str,
params: Optional["InvoicePayParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Invoice":
"""
Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your [subscriptions settings](https://dashboard.stripe.com/account/billing/automatic). However, if you'd like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.
"""
return cast(
"Invoice",
await self._request_async(
"post",
"/v1/invoices/{invoice}/pay".format(
invoice=sanitize_id(invoice),
),
base_address="api",
params=params,
options=options,
),
)
def remove_lines(
self,
invoice: str,
params: "InvoiceRemoveLinesParams",
options: Optional["RequestOptions"] = None,
) -> "Invoice":
"""
Removes multiple line items from an invoice. This is only possible when an invoice is still a draft.
"""
return cast(
"Invoice",
self._request(
"post",
"/v1/invoices/{invoice}/remove_lines".format(
invoice=sanitize_id(invoice),
),
base_address="api",
params=params,
options=options,
),
)
async def remove_lines_async(
self,
invoice: str,
params: "InvoiceRemoveLinesParams",
options: Optional["RequestOptions"] = None,
) -> "Invoice":
"""
Removes multiple line items from an invoice. This is only possible when an invoice is still a draft.
"""
return cast(
"Invoice",
await self._request_async(
"post",
"/v1/invoices/{invoice}/remove_lines".format(
invoice=sanitize_id(invoice),
),
base_address="api",
params=params,
options=options,
),
)
def send_invoice(
self,
invoice: str,
params: Optional["InvoiceSendInvoiceParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Invoice":
"""
Stripe will automatically send invoices to customers according to your [subscriptions settings](https://dashboard.stripe.com/account/billing/automatic). However, if you'd like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.
Requests made in test-mode result in no emails being sent, despite sending an invoice.sent event.
"""
return cast(
"Invoice",
self._request(
"post",
"/v1/invoices/{invoice}/send".format(
invoice=sanitize_id(invoice),
),
base_address="api",
params=params,
options=options,
),
)
async def send_invoice_async(
self,
invoice: str,
params: Optional["InvoiceSendInvoiceParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Invoice":
"""
Stripe will automatically send invoices to customers according to your [subscriptions settings](https://dashboard.stripe.com/account/billing/automatic). However, if you'd like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.
Requests made in test-mode result in no emails being sent, despite sending an invoice.sent event.
"""
return cast(
"Invoice",
await self._request_async(
"post",
"/v1/invoices/{invoice}/send".format(
invoice=sanitize_id(invoice),
),
base_address="api",
params=params,
options=options,
),
)
def update_lines(
self,
invoice: str,
params: "InvoiceUpdateLinesParams",
options: Optional["RequestOptions"] = None,
) -> "Invoice":
"""
Updates multiple line items on an invoice. This is only possible when an invoice is still a draft.
"""
return cast(
"Invoice",
self._request(
"post",
"/v1/invoices/{invoice}/update_lines".format(
invoice=sanitize_id(invoice),
),
base_address="api",
params=params,
options=options,
),
)
async def update_lines_async(
self,
invoice: str,
params: "InvoiceUpdateLinesParams",
options: Optional["RequestOptions"] = None,
) -> "Invoice":
"""
Updates multiple line items on an invoice. This is only possible when an invoice is still a draft.
"""
return cast(
"Invoice",
await self._request_async(
"post",
"/v1/invoices/{invoice}/update_lines".format(
invoice=sanitize_id(invoice),
),
base_address="api",
params=params,
options=options,
),
)
def void_invoice(
self,
invoice: str,
params: Optional["InvoiceVoidInvoiceParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Invoice":
"""
Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to [deletion](https://docs.stripe.com/api#delete_invoice), however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.
Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you're doing business in. You might need to [issue another invoice or <a href="#create_credit_note">credit note](https://docs.stripe.com/api#create_invoice) instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.
"""
return cast(
"Invoice",
self._request(
"post",
"/v1/invoices/{invoice}/void".format(
invoice=sanitize_id(invoice),
),
base_address="api",
params=params,
options=options,
),
)
async def void_invoice_async(
self,
invoice: str,
params: Optional["InvoiceVoidInvoiceParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Invoice":
"""
Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to [deletion](https://docs.stripe.com/api#delete_invoice), however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.
Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you're doing business in. You might need to [issue another invoice or <a href="#create_credit_note">credit note](https://docs.stripe.com/api#create_invoice) instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.
"""
return cast(
"Invoice",
await self._request_async(
"post",
"/v1/invoices/{invoice}/void".format(
invoice=sanitize_id(invoice),
),
base_address="api",
params=params,
options=options,
),
)
def create_preview(
self,
params: Optional["InvoiceCreatePreviewParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Invoice":
"""
At any time, you can preview the upcoming invoice for a subscription or subscription schedule. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.
You can also preview the effects of creating or updating a subscription or subscription schedule, including a preview of any prorations that will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update.
The recommended way to get only the prorations being previewed on the invoice is to consider line items where parent.subscription_item_details.proration is true.
Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer's discount.
Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. [Learn more](https://docs.stripe.com/currencies/conversions)
"""
return cast(
"Invoice",
self._request(
"post",
"/v1/invoices/create_preview",
base_address="api",
params=params,
options=options,
),
)
async def create_preview_async(
self,
params: Optional["InvoiceCreatePreviewParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Invoice":
"""
At any time, you can preview the upcoming invoice for a subscription or subscription schedule. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.
You can also preview the effects of creating or updating a subscription or subscription schedule, including a preview of any prorations that will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update.
The recommended way to get only the prorations being previewed on the invoice is to consider line items where parent.subscription_item_details.proration is true.
Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer's discount.
Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. [Learn more](https://docs.stripe.com/currencies/conversions)
"""
return cast(
"Invoice",
await self._request_async(
"post",
"/v1/invoices/create_preview",
base_address="api",
params=params,
options=options,
),
)
|