v1

latestOpenAPI 3.0.02026-07-14311851.4 KB

Settings

Get Subscriptions Settings

Lists the current Subscriptions settings in your store.

get/settings

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

defaultSlastring nullable required

Default delivery method.

deliveryChannelsstring[] required

Array containing delivery channels.

executionHourInUtcinteger required

Indicates the time future subscription orders will be generated.

isMultipleInstallmentsEnabledOnCreationboolean required

Defines whether or not multiple installments are enabled when a subscription is created.

isMultipleInstallmentsEnabledOnUpdateboolean required

Defines whether or not multiple installments are enabled when a subscription is updated.

isUsingV3boolean required

Indicates whether or not Subscriptions V3 is enabled.

manualPriceAllowedboolean required

When set to true, this property enables manual price configuration in subscription items. This is valid for all existing subscriptions, provided that there is a manual price configured and that isUsingV3 is true.

onMigrationProcessboolean required

Indicates whether or not the account is in the migration process to Subscriptions V3.

orderCustomDataAppIdstring required

When filled, this field passes along the customData infomration in the order to the future recurrent subscription orders.

postponeExpirationboolean required

Defines whether or not the expiration of subscriptions can be postponed.

randomIdGenerationboolean required

Defines whether or not the subscription order IDs will be randomly generated.

slaOptionstring required

Delivery method.

useItemPriceFromOriginalOrderboolean required

When set to true, this property enables using the manual price for each item from the original subscription order. This is only valid for new subscriptions, created from the moment this configuration is enabled. For this to work, it is mandatory that the manualPriceAllowed property is set to true and that isUsingV3 is true.

workflowVersionstring required

Workflow version.

Example response

{
  "defaultSla": null,
  "deliveryChannels": [
    "delivery"
  ],
  "executionHourInUtc": 9,
  "isMultipleInstallmentsEnabledOnCreation": false,
  "isMultipleInstallmentsEnabledOnUpdate": false,
  "isUsingV3": true,
  "manualPriceAllowed": false,
  "onMigrationProcess": false,
  "orderCustomDataAppId": null,
  "postponeExpiration": false,
  "randomIdGeneration": false,
  "slaOption": "NONE",
  "useItemPriceFromOriginalOrder": false,
  "workflowVersion": "1.1"
}