This setting also determines whether or not your support phone number appears on other customer facing documents like the invoice email, invoice PDF, and hosted invoice page.
The largest file size permitted for a custom logo image is KB. For best results, we recommend that your logo is a square image larger than x pixels. You can preview your changes in real-time within the Dashboard.
To see how a receipt looks when it is sent, click Send test email… to send yourself a test receipt. Stripe receipts will help you comply by filling in all the fields that we know. However, you must send a few fields in the description parameter:.
For destination charges and separate charges and transfers , receipts are sent based on the email settings, branding, and public business information of the platform account.
For direct charges , receipts are sent based on the email settings, branding, and public business information of the Connected account. You can configure email settings for both your platform and Standard accounts in the Dashboard. This means that you manage the email settings in each connected account individually. Sign in. Create account. Business operations.
Financial services. The coupons to redeem into discounts for the invoice. Pass an empty string to avoid inheriting any discounts. ID of the coupon to create a new discount for. ID of an existing discount on the object or one of its ancestors to reuse. Verification method for the intent. It must contain at least one letter. ID of an existing, connected Stripe account. The amount that will be transferred automatically when the invoice is paid.
If no amount is set, the full amount is transferred. Returns the invoice object if there are pending invoice items to invoice. Returns an invoice object if a valid invoice ID was provided. The invoice object contains a lines hash that contains information about the subscriptions and invoice items that have been applied to the invoice, as well as any prorations that Stripe has automatically calculated.
For invoice items and prorations, the amount attribute is the same as for the invoice item or proration respectively. The invoice object has both a subtotal and a total. The subtotal represents the total before any discounts, while the total is the final amount to be charged to the customer after all coupons have been applied. Draft invoices are fully editable. This field can be updated only on draft invoices.
Pass an empty string to remove previously-defined fields. The number of days from which the invoice is created until it is due. This field can only be updated on draft invoices. Pass an empty string to remove previously-defined tax rates. The discounts that will apply to the invoice. Pass an empty string to remove previously-defined discounts. This will be unset if you POST an empty value.
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. A successfully deleted invoice.
Otherwise, this call an error , such as if the invoice has already been deleted. Stripe automatically finalizes drafts before sending and attempting payment on invoices. Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings.
This effectively forgives the difference between the amount available on the source and the amount due. An example for this case is with ACH Credit Transfers and wires: if the amount wired is less than the amount due by a small amount, you might want to forgive the difference.
Defaults to false. Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to true off-session.
Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. A PaymentMethod to be charged. A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid. Stripe will automatically send invoices to customers according to your subscriptions settings. 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. Mark a finalized invoice as void. Voiding an invoice is similar to deletion , however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found. Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.
There is also a URL where you can retrieve the full paginated list of line items. A cursor for use in pagination. A limit on the number of objects to be returned. Limit can range between 1 and , and the default is At any time, you can preview the upcoming invoice for a customer.
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.
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.
You can preview the effects of updating a subscription, including a preview of what proration will take place. Details about the customer you want to invoice or overrides for an existing customer. Appears on invoices emailed to this customer. Tax details about the customer. A recent IP address of the customer used for tax reporting and tax location inference.
Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. One of none , exempt , or reverse.
Value of the tax ID. Settings for automatic tax lookup for this invoice preview. The code of the coupon to apply. The invoice can be previewed without a coupon by passing this value as an empty string. The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. List of invoice items to add or update in the upcoming invoice preview.
The integer amount in cents of previewed invoice item. Only applicable to new invoice items. An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items. The coupons to redeem into discounts for the invoice item in the preview.
The ID of the invoice item to update in preview. If not specified, a new invoice item will be added to the preview of the upcoming invoice. The period associated with this invoice item. The end of the period, which must be greater than or equal to the start. The start of the period. The ID of the price object. Data used to generate a new Price object inline.
The ID of the product that this price will belong to. A positive integer in cents or 0 for a free price representing how much to charge.
Non-negative integer. The quantity of units for the invoice item. The tax rates that apply to the item. The integer unit amount in cents of the charge to be applied to the upcoming invoice. Cannot be used with subscription or subscription fields. This is used to determine the date of the first full invoice, and, for plans with month or year intervals, the day of the month for subsequent invoices.
For existing subscriptions, the value can only be set to now or unchanged. Timestamp indicating when the subscription should be scheduled to cancel. Boolean indicating whether this subscription should cancel at the end of the current period. This simulates the subscription being canceled or expired immediately. If provided, the invoice returned will preview updating or creating a subscription with these default tax rates.
A list of up to 20 subscription items, each with an attached price. For example, you can use this to display a message near the correct form field. If the error is specific to the type of payment method, the payment method type that had a problem.
This field is only populated for invoice-related errors. The type of error returned. The time at which payment will next be attempted. A unique, identifying string that appears on emails sent to the customer for this invoice. The account if any for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account.
See the Invoices with Connect documentation for details. Whether payment was successfully collected for this invoice. Configuration settings for the PaymentIntent that is generated when the invoice is finalized. Additional fields for Mandate creation.
Transaction type of the mandate. Bank account verification method. Preferred language of the Bancontact authorization page that the customer is redirected to. We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements.
However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine.
Triggers 3D Secure authentication only if it is required. The list of payment method types e. Total amount of all post-payment credit notes issued for this invoice. Total amount of all pre-payment credit notes issued for this invoice.
This is the transaction number that appears on email receipts sent for this invoice. Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. The timestamps at which the invoice status was updated. The time that the invoice draft was finalized. The time that the invoice was marked uncollectible. The time that the invoice was paid. The time that the invoice was voided. Only set for upcoming invoices that preview prorations.
The time used to calculate prorations. Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated. The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice. The total invoice amount threshold boundary if it triggered the threshold invoice.
Indicates which line items triggered a threshold invoice. The IDs of the line items that triggered the threshold invoice. Products and prices. Understand taxes. Payment methods. Working with invoices. Use the Dashboard.
Integrate with the API. Customize invoices. Send customer emails. Hosted Invoice Page. Invoicing and Connect. Automated invoicing. Automatic reconciliation. Automatic collection. Automatic charging. Additional features.
Multiple currencies. No-code options. English United States. Home Payments Invoicing. Customize invoices Customize the content and branding of your invoices. The Invoice template.
0コメント