Global API
...
Request
Invoice

Invoice - Stripe

2min

To create an Invoice in Stripe, the following properties can be provided. Those marked with * are required.

Invoice

Field Name

Data Type

Description

processorCustomerId*

String

Customer Id in the Processor (Find this)

items*

List (items)

At least one line item is required to create an Invoice.

processorId*

String

Id of the Stripe processor connected to the Salesforce org

couponId

String

Id of the Coupon to add discount on the Invoice

dueDate

DateTime

Conditionally required. "dueDate" value is required to create and send the Invoice.

invoiceStatus

String

We currently support SEND_TO_CUSTOMER.

pendingInvoiceItemsBehavior

String

One of include, exclude, or include_and_require, by default set to exclude the pending items on Customer.

collectionMethod

String

Either 'send_invoice' or 'charge_automatically'. By default 'send_invoice'.

processorPaymentMethodId

String

Passed if collectionMethod is charge_automatically. If not set, invoices will use the customer’s default_source.

Items

Field Name

Data Type

Description

processorPriceId*

String

Id of the specific Product/Price that is getting added to the Invoice. Note: this is the Id in the Processor not in Salesforce.

quantity

Integer

The quantity of products for which Invoice to be created

amount

Decimal

readOnly field

chargeCurrency

String

readOnly field

description

String

readOnly field

invoice

String

readOnly field

name

String

readOnly field

procesorSubscriptionId

String

readOnly field

salesforceId

String

readOnly field

salesforcePriceId

String

readOnly field

salesforceSubscriptionId

String

readOnly field

unitAmount

Decimal

readOnly field

unitAmountDecimal

Decimal

readOnly field



Click here to view a sample Create Invoice Request and Response.

Updated 17 Oct 2023
Doc contributor
Doc contributor
Doc contributor
Did this page help you?