VTEX Settings API

openapi: 3.2.0
info:
  title: VTex Subscriptions API (v3) Settings API
  description: '

    A **Subscription** is a list of items (SKUs) tied to certain recurring purchase settings:


    - User profile

    - Address

    - Payment method

    - Frequency

    - Cycle


    Once you have [configured subscriptions](https://help.vtex.com/tutorial/how-to-configure-subscriptions%20--1FA9dfE7vJqxBna9Nft5Sj) in your store, the Subscriptions API allows you to create, manage and monitor your customers'' subscriptions.


    ![image](https://user-images.githubusercontent.com/77292838/213024675-9407863b-0c55-4282-9442-306352716abe.png)


    To read more about the Subscriptions feature, check our article [How Subscription works](https://help.vtex.com/tutorial/how-subscriptions-work--frequentlyAskedQuestions_4453).'
  contact: {}
  version: '1.0'
servers:
- url: https://{accountName}.{environment}.com.br
  description: VTEX server URL.
  variables:
    accountName:
      description: Name of the VTEX account. Used as part of the URL.
      default: apiexamples
    environment:
      description: Environment to use. Used as part of the URL.
      enum:
      - vtexcommercestable
      default: vtexcommercestable
security:
- appKey: []
  appToken: []
tags:
- name: Settings
paths:
  /api/rns/settings:
    get:
      tags:
      - Settings
      summary: VTex Get Subscription Settings
      description: List the details of the settings of a given subscription.
      operationId: GetSettings
      parameters:
      - name: Content-Type
        in: header
        description: Type of the content being sent.
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - name: Accept
        in: header
        description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/settings'
      deprecated: false
    post:
      tags:
      - Settings
      summary: VTex Edit Subscriptions settings
      description: Edits Subscriptions settings in your store.
      operationId: EditSettings
      parameters:
      - name: Content-Type
        in: header
        description: Type of the content being sent.
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - name: Accept
        in: header
        description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      requestBody:
        description: Request body
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/settings'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/settings'
      deprecated: false
components:
  schemas:
    settings:
      title: ''
      description: Subscriptions settings
      type: object
      required:
      - slaOption
      - defaultSla
      - isUsingV3
      - onMigrationProcess
      - executionHourInUtc
      - workflowVersion
      - deliveryChannels
      - randomIdGeneration
      - isMultipleInstallmentsEnabledOnCreation
      - isMultipleInstallmentsEnabledOnUpdate
      - orderCustomDataAppId
      - postponeExpiration
      - manualPriceAllowed
      - useItemPriceFromOriginalOrder
      properties:
        slaOption:
          title: slaOption
          description: Delivery method.
          type: string
          default: ''
          example: NONE
        defaultSla:
          title: defaultSla
          description: Default delivery method.
          type:
          - string
          - 'null'
          default: null
          example: null
        isUsingV3:
          title: isUsingV3
          description: Indicates whether or not Subscriptions V3 is enabled.
          type: boolean
          default: false
          example: true
        onMigrationProcess:
          title: onMigrationProcess
          description: Indicates whether or not the account is in the migration process to Subscriptions V3.
          type: boolean
          default: false
          example: false
        executionHourInUtc:
          title: executionHourInUtc
          description: Indicates the time future subscription orders will be generated.
          type: integer
          default: 0
          example: 9
        workflowVersion:
          title: workflowVersion
          description: Workflow version.
          type: string
          default: ''
          example: '1.1'
        deliveryChannels:
          title: deliveryChannels
          description: Array containing delivery channels.
          type: array
          default: []
          items:
            title: ''
            description: 'Type of delivery channel. The values that are possible are: `pickupInPoint` for pickup point and `delivery` for regular delivery.'
            type: string
            example: delivery
          example: delivery
        randomIdGeneration:
          title: randomIdGeneration
          description: Defines whether or not the subscription order IDs will be randomly generated.
          type: boolean
          default: false
          example: false
        isMultipleInstallmentsEnabledOnCreation:
          title: isMultipleInstallmentsEnabledOnCreation
          description: Defines whether or not multiple installments are enabled when a subscription is created.
          type: boolean
          default: false
          example: false
        isMultipleInstallmentsEnabledOnUpdate:
          title: isMultipleInstallmentsEnabledOnUpdate
          description: Defines whether or not multiple installments are enabled when a subscription is updated.
          type: boolean
          default: false
          example: false
        orderCustomDataAppId:
          title: orderCustomDataAppId
          description: When filled, this field passes along the `customData` infomration in the order to the future recurrent subscription orders.
          type: string
          default: null
          example: null
        postponeExpiration:
          title: postponeExpiration
          description: Defines whether or not the expiration of subscriptions can be postponed.
          type: boolean
          default: false
          example: false
        manualPriceAllowed:
          title: manualPriceAllowed
          description: 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`.
          type: boolean
          default: false
          example: false
        useItemPriceFromOriginalOrder:
          title: useItemPriceFromOriginalOrder
          description: 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`.
          type: boolean
          default: false
          example: false
      example:
      - slaOption: NONE
        defaultSla: null
        isUsingV3: true
        onMigrationProcess: false
        executionHourInUtc: 9
        workflowVersion: '1.1'
        deliveryChannels:
        - delivery
        randomIdGeneration: false
        isMultipleInstallmentsEnabledOnCreation: false
        isMultipleInstallmentsEnabledOnUpdate: false
        orderCustomDataAppId: null
        postponeExpiration: false
        manualPriceAllowed: false
        useItemPriceFromOriginalOrder: false
  securitySchemes:
    appKey:
      type: apiKey
      in: header
      name: X-VTEX-API-AppKey
    appToken:
      type: apiKey
      in: header
      name: X-VTEX-API-AppToken