POST /v1/invoices/{invoice}/pay

Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. 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.

Servers

https://api.stripe.com/

Path parameters

Name	Type	Required	Description
`invoice`	String	Yes

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/x-www-form-urlencoded"

Request body fields

Name	Type	Required	Description
`source`	String	No	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.
`forgive`	Boolean	No	In cases where the source used to pay the invoice has insufficient funds, passing `forgive=true` controls whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due. Passing `forgive=false` will fail the charge if the source hasn't been pre-funded with the right amount. 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`.
`paid_out_of_band`	Boolean	No	Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to `false`.
`expand[]`	Array	No	Specifies which fields in the response should be expanded.
`mandate`		No	ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the payment_method param or the invoice's default_payment_method or default_source, if set.
`off_session`	Boolean	No	Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `true` (off-session).
`payment_method`	String	No	A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.