v356

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-031733562.1 MB
Invoices

Get invoice payment settings by invoice ID

Get payment settings for invoices by invoice ID. 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.

get/payments/settings/invoices/for-invoice/{id}

Path parameters

idstring required

Unique invoice ID

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

Sequence-Version'2024-07-30'

Use this header to select an API version

Response

OK

idstring required

Unique payment provider id.

sequenceAccountIdstring required

Sequence Account ID.

invoiceIdstring required

Invoice 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",
  "paymentProvider": "STRIPE"
}