v356

OpenAPI 3.0.3raw.githubusercontent.com2026-08-031733562.1 MB
Customers

Create customer payment settings

Create payment settings for customers. Invoices for customers 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. You can override customer payment settings with billing schedule payment settings and invoice payment settings.

post/payments/settings/customers

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

Sequence-Version'2024-07-30'

Use this header to select an API version

Request body

customerIdstring required

Customer Account ID.

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

Example request

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

Response

Created

idstring required

Unique payment provider id.

sequenceAccountIdstring required

Sequence Account ID.

customerIdstring required

Customer Account ID.

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

Example response

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