v1

latestOpenAPI 3.0.02026-07-261733191.1 MB

Invoices

Create invoice payment settings

Create payment settings for invoices. Invoices with payment settings contain payment links. If payment details are on file with Stripe or other payment providers, then payments are automatically collected when you finalise and send an invoice. Invoice payment settings override billing schedule payment settings and customer payment settings.

post/payments/settings/invoices

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

Sequence-Version'2024-07-30'

Use this header to select an API version

Request body

invoiceIdstring required

Invoice ID.

customerIdstring nullable

Customer ID.

paymentProvider'STRIPE' | 'GOCARDLESS' | 'NONE' required

Example request

{
  "invoiceId": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
  "customerId": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
  "paymentProvider": "STRIPE"
}

Response

Created

idstring required

Unique payment provider id.

sequenceAccountIdstring required

Sequence Account ID.

invoiceIdstring required

Invoice ID.

customerIdstring required

Customer ID.

paymentProvider'STRIPE' | 'GOCARDLESS' | 'NONE' required

Example response

{
  "id": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
  "sequenceAccountId": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
  "invoiceId": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
  "customerId": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
  "paymentProvider": "STRIPE"
}