Reset Checkout Settings

DELETE

/api/accounts/:account_id/checkout-settings

DELETE

/api/accounts/:account_id/checkout-settings

$ curl -X DELETE https://app.paymentkit.com/api/accounts/account_id/checkout-settings \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "session_expiration_minutes": 1440,
3   "enable_posthog": true,
4   "posthog_api_key": "phc_9f8e7d6c5b4a3",
5   "posthog_init_keys": {
6     "api_host": "https://app.posthog.com",
7     "autocapture": true
8   },
9   "create_new_customer_per_session": true,
10   "detach_failed_payment_method": true,
11   "enable_promo_code": true,
12   "default_country": "US",
13   "billing_address_country": true,
14   "billing_address_address": true,
15   "billing_address_city_state": true,
16   "billing_address_zip": true,
17   "enable_shipping_address": true,
18   "enable_consent_checkbox": true,
19   "custom_checkbox_text": "I agree to the terms and conditions",
20   "custom_footer_text": "Thank you for shopping with us!",
21   "allow_duplicate_product_subscriptions": true,
22   "primary_color": "#1FC55B",
23   "text_color": "#FFFFFF",
24   "background_color": "#1C1C1C"
25 }

Reset checkout settings to defaults.

Authentication

AuthorizationBearer

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

Path parameters

account_idstringRequired

Response

Successful Response

session_expiration_minutesinteger or nullOptional1-10080Defaults to 1440

Checkout session expiration time in minutes. Defaults to 1440 (24h). Configurable from 1h to 168h (7 days); the UI presents this in hours.

enable_posthogboolean or nullOptionalDefaults to false

Enable PostHog analytics for checkout tracking

posthog_api_keystring or nullOptional

PostHog Project API Key

posthog_init_keysmap from strings to any or nullOptional

Custom keys to pass to posthog.init

create_new_customer_per_sessionboolean or nullOptionalDefaults to false

Create a new customer for every checkout session

detach_failed_payment_methodboolean or nullOptionalDefaults to false

Detach payment methods that fail on checkout

enable_promo_codeboolean or nullOptionalDefaults to true

Show the promo code entry field on checkout

default_countrystring or nullOptional

Default country for checkout

billing_address_countryboolean or nullOptionalDefaults to true

Collect country in billing address

billing_address_addressboolean or nullOptionalDefaults to true

Collect street address in billing address

billing_address_city_stateboolean or nullOptionalDefaults to true

Collect city/state in billing address

billing_address_zipboolean or nullOptionalDefaults to true

Collect ZIP code in billing address

enable_shipping_addressboolean or nullOptionalDefaults to true

Collect shipping address on checkout

enable_consent_checkboxboolean or nullOptionalDefaults to true

Require the consent checkbox before completing checkout

custom_checkbox_textstring or nullOptional

Custom text for the consent checkbox

custom_footer_textstring or nullOptional

Custom footer text for the checkout page

allow_duplicate_product_subscriptionsboolean or nullOptionalDefaults to false

Allow creating subscriptions for products a customer already has a non-cancelled subscription for

primary_colorstring or nullOptionalDefaults to #1FC55B

Primary color for checkout in hex format

text_colorstring or nullOptionalDefaults to #FFFFFF

Text color for checkout in hex format

background_colorstring or nullOptionalDefaults to #1C1C1C

Background color for checkout in hex format

Errors

422

Unprocessable Entity Error