Create an invoice

post

https://api.fastspring.com/invoices/paymentInvoice

Creates and finalizes a new invoice with custom contacts, items, pricing, and optional payment configuration.

This endpoint returns a detailed invoice object, including totals, payment URLs, and contact metadata, based on the request body provided.

Body Params

Payload to create and finalize a payment invoice.

currencyCode

string

required

ISO 4217 currency code used for the invoice.

languageCode

string

Language/locale code for the invoice.

autoConvertPaymentCurrency

boolean

Whether to auto-convert the currency based on the buyer’s location.

contacts

array of objects

required

Billing and delivery contact details for the invoice.

contacts*

dueDate

date-time

When the invoice is due (ISO 8601 format).

invoiceNote

string

Optional non-structured note for internal or customer use.

invoiceItems

array of objects

required

Line items (products/services) included in the invoice.

invoiceItems*

paymentMethod

string

required

Payment method to use. Common values include CARD, PAYPAL, WIRE, ACH. Refer to FastSpring dashboard for the full list of supported methods.

mode

string

enum

required

Mode used to create the invoice (test or live).

Allowed:

tagsJson

string

Stringified JSON object of key-value pairs to attach as metadata to this invoice. Values may be strings or arrays of strings. Must be serialized as a JSON string (not a nested object). Stored on the invoice and returned in both POST and GET responses.

Responses

200OK

401Authentication credentials are missing or invalid.

429Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header.

500Internal server error.