Update Brand Settings

PATCH

/api/accounts/:account_id/brand-settings

PATCH

/api/accounts/:account_id/brand-settings

$ curl -X PATCH https://app.paymentkit.com/api/accounts/account_id/brand-settings \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: multipart/form-data" \
>      -F name='{
>   "type": "json"
> }' \
>      -F brand_color='{
>   "type": "json"
> }' \
>      -F accent_color='{
>   "type": "json"
> }' \
>      -F custom_domain='{
>   "type": "json"
> }' \
>      -F privacy_policy_url='{
>   "type": "json"
> }' \
>      -F terms_of_service_url='{
>   "type": "json"
> }' \
>      -F statement_descriptor_prefix='{
>   "type": "json"
> }' \
>      -F statement_descriptor_consent='{
>   "type": "json"
> }' \
>      -F icon=@"[object Object]" \
>      -F icon_dark=@"[object Object]" \
>      -F logo=@"[object Object]" \
>      -F logo_light=@"[object Object]" \
>      -F clear_icon='{
>   "type": "json"
> }' \
>      -F clear_icon_dark='{
>   "type": "json"
> }' \
>      -F clear_logo='{
>   "type": "json"
> }' \
>      -F clear_logo_light='{
>   "type": "json"
> }'

1 {
2   "id": "acc_dev_x7k9m2n4p8q1",
3   "name": "Production Environment",
4   "description": "Main production environment",
5   "account_type": "production",
6   "organization_id": "string",
7   "settings": {
8     "auto_deploy": true,
9     "notifications": false
10   },
11   "created_at": "2024-01-15T09:30:00Z",
12   "updated_at": "2024-01-15T09:30:00Z",
13   "is_sandbox": false,
14   "parent_account_id": "acc_dev_abc123",
15   "sandbox_account_count": 1,
16   "is_archived": false,
17   "brand_settings": {
18     "icon": "https://storage.googleapis.com/bucket/icon.png",
19     "icon_dark": "https://storage.googleapis.com/bucket/icon_dark.png",
20     "logo": "https://storage.googleapis.com/bucket/logo.png",
21     "logo_light": "https://storage.googleapis.com/bucket/logo_light.png",
22     "brand_color": "#FF5733",
23     "accent_color": "#3498DB",
24     "custom_domain": "pay.example.com",
25     "privacy_policy_url": "https://example.com/privacy",
26     "terms_of_service_url": "https://example.com/terms",
27     "statement_descriptor_prefix": "ACME"
28   },
29   "invoice_settings": {
30     "billing_address": {
31       "line1": "123 Main St",
32       "line2": "Suite 100",
33       "line3": "Building A",
34       "city": "San Francisco",
35       "state": "CA",
36       "country": "US",
37       "zip_code": "94105"
38     },
39     "tax_ids": [
40       {
41         "value": "PBGPS03456H",
42         "is_default": true
43       }
44     ],
45     "custom_footer": "Thank you for your business!"
46   },
47   "notification_settings": {
48     "invoice": {
49       "on_finalized": true,
50       "on_paid": true
51     },
52     "dunning": {
53       "failed_payment": true
54     },
55     "slack_enabled": true,
56     "slack_webhook_urls": [
57       "string"
58     ],
59     "slack_payment_succeeded": true,
60     "slack_payment_failed": true,
61     "email_enabled": true,
62     "emails_to_notify": [
63       "string"
64     ],
65     "email_payment_succeeded": true,
66     "email_payment_failed": true,
67     "email_config": {
68       "from_email": "billing@example.com",
69       "reply_to_email": "support@example.com",
70       "email_signature_name": "John Smith",
71       "email_signature_title": "Billing Department",
72       "cc_recipients": [
73         "cc1@merchant.com",
74         "cc2@merchant.com"
75       ],
76       "bcc_recipients": [
77         "bcc1@merchant.com",
78         "bcc2@merchant.com"
79       ],
80       "primary_color": "#FF5733",
81       "background_color": "#E8E8E8",
82       "text_color": "#333333"
83     }
84   },
85   "billing_portal_settings": {
86     "allow_update_sub": true,
87     "allow_cancel_sub": true,
88     "upgrade_immediate": true,
89     "cancel_immediate": true,
90     "downgrade_immediate": true,
91     "hide_price_ids": [
92       "price_abc123",
93       "price_def456"
94     ],
95     "support_email": "string"
96   },
97   "dunning_settings": {
98     "enable_retries": true,
99     "enable_emails": true,
100     "contact_info": {
101       "from_email": "billing@example.com",
102       "reply_to_email": "support@example.com",
103       "email_signature_title": "Billing Department",
104       "email_signature_name": "John Smith",
105       "cc_recipients": [
106         "cc1@merchant.com",
107         "cc2@merchant.com"
108       ],
109       "bcc_recipients": [
110         "bcc1@merchant.com",
111         "bcc2@merchant.com"
112       ]
113     },
114     "subscription_status_on_failure": "cancel",
115     "invoice_status_on_failure": "mark_uncollectible",
116     "apply_to_product_ids": [
117       "prod_abc123",
118       "prod_def456"
119     ],
120     "settle_past_due_on_pm_update": true,
121     "update_renewal_on_overdue_paid": true
122   },
123   "checkout_settings": {
124     "session_expiration_minutes": 1440,
125     "enable_posthog": true,
126     "posthog_api_key": "phc_abcdef123456",
127     "posthog_init_keys": {
128       "api_host": "https://app.posthog.com",
129       "autocapture": true
130     },
131     "create_new_customer_per_session": true,
132     "detach_failed_payment_method": true,
133     "enable_promo_code": true,
134     "default_country": "string",
135     "billing_address_country": true,
136     "billing_address_address": true,
137     "billing_address_city_state": true,
138     "billing_address_zip": true,
139     "enable_shipping_address": true,
140     "enable_consent_checkbox": true,
141     "custom_checkbox_text": "string",
142     "custom_footer_text": "string",
143     "allow_duplicate_product_subscriptions": true,
144     "primary_color": "string",
145     "text_color": "string",
146     "background_color": "string"
147   },
148   "fraud_settings": {
149     "enabled": false,
150     "custom_message": "This payment method is not accepted."
151   },
152   "mit_settings": {
153     "cascading_enabled": true,
154     "fallback_processor_1_id": "proc_dev_a1b2c3d4e5f6g7h8",
155     "fallback_processor_2_id": "proc_dev_b2c3d4e5f6g7h8i9",
156     "update_default_pm_on_fallback": false,
157     "max_fallback_payment_methods": 1
158   },
159   "cit_processing_enabled": true,
160   "mit_processing_enabled": true,
161   "default_processor_route_id": "proute_dev_a1b2c3d4e5f6g7h8"
162 }

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

account_idstringRequired

Request

This endpoint expects a multipart form with multiple files.

namestring or nullOptional

Account name

brand_colorstring or nullOptional

Primary brand color in hex format

accent_colorstring or nullOptional

Accent color in hex format

custom_domainstring or nullOptional

Custom domain for checkout

privacy_policy_urlstring or nullOptional

URL to privacy policy page

terms_of_service_urlstring or nullOptional

URL to terms of service page

statement_descriptor_prefixstring or nullOptional

Statement descriptor prefix. 2-10 Latin chars, >=1 letter, no forbidden chars. Empty string clears it (falls back to account name).

statement_descriptor_consentbooleanOptionalDefaults to false

Consent to write the prefix to the connected Stripe account (read-don’t-overwrite; only writes when the Stripe prefix is empty).

iconfileOptional

Brand icon image (default / light-on-dark variant)

icon_darkfileOptional

Dark-on-light icon variant for use on light backgrounds. Surfaces fall back to icon if this is unset.

logofileOptional

Brand logo image (default / dark-on-light variant)

logo_lightfileOptional

Light-on-dark logo variant for use on dark backgrounds. Surfaces fall back to logo if this is unset.

clear_iconbooleanOptionalDefaults to false

Delete the existing icon image

clear_icon_darkbooleanOptionalDefaults to false

Delete the existing dark-bg icon image

clear_logobooleanOptionalDefaults to false

Delete the existing logo image

clear_logo_lightbooleanOptionalDefaults to false

Delete the existing dark-bg logo image

Response

Successful Response

idstring

Unique account identifier

namestring

Account name

descriptionstring or null

Account description

account_typestring

Account type

organization_idstring

Organization ID

settingsmap from strings to any or null

Account settings

created_atdatetime

When the account was created

updated_atdatetime

When the account was last updated

is_sandboxbooleanOptionalDefaults to false

Whether this is a sandbox account for testing

parent_account_idstring or nullOptional

ID of the parent live account (set for sandbox accounts)

sandbox_account_countinteger or nullOptional

Number of sandbox accounts linked to this account (only for live accounts)

is_archivedbooleanOptionalDefaults to false

Whether this account has been archived (soft-deleted)

brand_settingsobject or nullOptional

Brand customization settings for checkout

invoice_settingsobject or nullOptional

Invoice customization settings

notification_settingsobject or nullOptional

Notification settings for invoice/dunning and channels

billing_portal_settingsobject or nullOptional

Billing portal settings for customer self-service

dunning_settingsobject or nullOptional

Dunning settings for failed payment recovery

checkout_settingsobject or nullOptional

Checkout settings for session configuration and analytics

fraud_settingsobject or nullOptional

Fraud protection settings for card blocking

mit_settingsobject or nullOptional

MIT cascade control settings for subscription payments

cit_processing_enabledbooleanOptionalDefaults to true

Whether CIT (checkout/card) processing is enabled

mit_processing_enabledbooleanOptionalDefaults to true

Whether MIT (subscription/recurring) processing is enabled

default_processor_route_idstring or nullOptional

ID of the default processor route for card checkout. A processor route contains an ordered list of processors tried sequentially as a fallback chain. This route is used when no route is specified on a checkout session.

Errors

422

Unprocessable Entity Error