Skip to main content
PATCH
Update payment settings

Authorizations

Authorization
string
header
required

A Custral API key, created in Settings → Developers → Applications, sent as Authorization: Bearer sk_…. The X-Api-Key header is also accepted and takes precedence. Use a secret key (sk_…) from your server; a publishable key (pk_…) may hold only objects:read and usage:write. Never expose a secret key in a browser.

Body

application/json

Omitted fields stay as they are; "" clears a key. The customers object itself is picked in the app.

customerKey
string

A property key on the customers object. "" clears it.

Maximum string length: 100
billingContact
string
Maximum string length: 100
quoteFrom
object[]
Maximum array length: 20
payerParent
string
Maximum string length: 100
billingFields
object
paymentMethods
enum<string>[]
Minimum array length: 1
Available options:
card,
us_bank_account,
sepa_debit
defaultCollectionMethod
enum<string>
Available options:
autopay,
invoice
paymentTermsDays
integer
Required range: 0 <= x <= 365
allowedReturnDomains
string[]
Maximum array length: 50
Maximum string length: 253
stripeMatchMetadataKey
string
Maximum string length: 40

Response

200 - application/json

The saved settings.

data
object

Payment settings, naming objects and properties by key.

reqId
string

A per-request id (req_…). Quote it to support when reporting a problem.

Example:

"req_2a1f9c8e7b6d5"