comecerodocs

Get subscription settings

GET
/settings/subscription

Returns how subscriptions renew: reminders, payment retries, what customers may change themselves, and renewal emails. Settings are kept per mode: a test token works on the test settings, a live token on the live ones. Secret and trusted tokens may call it when their permissions include settings_subscription. Limited tokens may not.

Authorization

headerAuthorizationBearer <token>

A secret, trusted or limited token. See Authentication.

Query Parameters

show?string

Comma-separated fields to return; all others are left out. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

hide?string

Comma-separated fields to leave out of the response. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

formatted?boolean

When true, the object also has a formatted child with amounts and dates as display text in the shopper's language and currency (for example $19.99 or November 7, 2026). The default is false. See Localized formatting.

Defaultfalse

Response Body

The subscription settings.

application/json
  1. response

How subscriptions renew in the current mode: reminders, retries after a failed payment, what customers may change themselves, and renewal emails.

object?"settings_subscription"

The object type. Always settings_subscription.

Value in"settings_subscription"
url?string

The URL of this object.

Formaturi
account_id?string

The ID of the account the settings belong to.

test?boolean

True for the test mode settings, false for live.

date_modified?string

When the settings were last changed.

Formatdate-time
copy_affiliate_id_on_subscription_renewal?boolean

Copy the affiliate ID of the first order onto renewal orders.

subscription_renewal_notification_days?integer

Days before a renewal to send the customer a reminder. 0 sends none. Default 3.

Range0 <= value <= 30
subscription_invoice_payment_delay?integer

Hours between creating the renewal invoice and charging it, so you can change the invoice first. From 0 to 168. Default 0.

Range0 <= value <= 168
payment_retry_delay?integer

Days between tries after a renewal payment fails. Default 3.

Range1 <= value
allow_deep_payment_retries?boolean

When a retried payment succeeds, also queue up to three more open past due invoices of the same subscription for payment.

max_payment_attempts?integer

The most tries for a failed renewal payment. Default 4.

Range1 <= value
payment_retry_friday_bias?boolean

Move a retry that falls one day either side of a Friday to the Friday.

cancel_on_chargeback?boolean

Cancel the subscription when a chargeback is recorded on its payment.

allow_customer_subscription_cancel?boolean

Let customers cancel their own subscriptions. On accounts where Comecero is the seller, only Comecero can turn this off; a value you send is ignored.

allow_customer_subscription_downgrade?boolean

Let customers move to a cheaper product or a lower quantity.

allow_customer_subscription_upgrade?boolean

Let customers move to a more expensive product or a higher quantity.

use_customer_payment_currency?boolean

When the customer pays in a currency the product has no price for, keep the subscription in the customer's currency. When false, use the product's default price currency.

receipt_on_renewal?boolean

Email a receipt for each renewal payment.

digital_delivery_on_renewal?boolean

Send the downloads and license keys again on each renewal.

cancellation_reasons?array<>

The reasons offered when a subscription is cancelled. Up to 25, each up to 50 characters.

Itemsitems <= 25
immediate_upgrade_product_types?array<>

Product types whose upgrades apply at once. Other upgrades apply at the end of the billing period.

immediate_downgrade_product_types?array<>

Product types whose downgrades apply at once.

formatted?

Display text for the dates. Returned only when formatted=true.

Example Request
curl -X GET 'https://api.comecero.com/api/v1/settings/subscription'
Example Response
{  "object": "settings_subscription",  "url": "https://api.comecero.com/api/v1/settings/subscription",  "account_id": "AB1234",  "test": true,  "date_modified": "2026-10-02T14:21:07Z",  "copy_affiliate_id_on_subscription_renewal": false,  "subscription_renewal_notification_days": 3,  "subscription_invoice_payment_delay": 0,  "payment_retry_delay": 3,  "allow_deep_payment_retries": true,  "max_payment_attempts": 4,  "payment_retry_friday_bias": true,  "allow_customer_subscription_cancel": true,  "allow_customer_subscription_downgrade": true,  "allow_customer_subscription_upgrade": true,  "use_customer_payment_currency": false,  "cancel_on_chargeback": true,  "receipt_on_renewal": true,  "digital_delivery_on_renewal": true,  "cancellation_reasons": [    "Too expensive",    "No longer needed"  ],  "immediate_upgrade_product_types": [    "digital",    "service"  ],  "immediate_downgrade_product_types": []}