> ## Documentation Index
> Fetch the complete documentation index at: https://www.commercengine.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Pause loyalty program

> Pauses the loyalty program, setting its status to `paused`. Can only be used when the current status is `active` or `paused`. Returns the updated `LoyaltyProgram` object.



## OpenAPI

````yaml https://openapi.commercengine.io/ce-admin.json put /customers/loyalty-program/{id}/pause
openapi: 3.2.0
info:
  title: CE Admin APIs
  version: '1.0'
  summary: Comprehensive admin interface for managing your e-commerce platform
  description: >-
    Complete administrative API suite for Commerce Engine, providing powerful
    tools to manage products, orders, customers, inventory, analytics, and
    system configuration. Designed for administrators and backend integrations
    requiring full platform control.
  license:
    name: All Rights Reserved
    url: https://www.commercengine.io/contact-us
  contact:
    email: support@commercengine.io
    url: https://www.commercengine.io/contact-us
    name: Support
servers:
  - url: https://staging.api.commercengine.io/api/v1/{store_id}/admin
    description: Staging Server
    variables:
      store_id:
        default: store_id
        description: Store ID
  - url: https://prod.api.commercengine.io/api/v1/{store_id}/admin
    description: Prod Server
    variables:
      store_id:
        default: store_id
        description: Store ID
security:
  - Authorization: []
tags:
  - name: section-catalog
    summary: Catalog
    kind: nav
  - name: Products
    description: >-
      Create and update products; manage their channels and category
      assignments, and list SKUs.
    summary: Products
    kind: nav
    parent: section-catalog
  - name: Variants
    description: Create, read and update product variants individually or in bulk.
    summary: Variants
    kind: nav
    parent: section-catalog
  - name: Categories
    description: Manage catalog categories and the attributes assigned to them.
    summary: Categories
    kind: nav
    parent: section-catalog
  - name: Product attributes
    description: Define product attributes and the attribute sets that organize them.
    summary: Product attributes
    kind: nav
    parent: section-catalog
  - name: Inventory
    description: >-
      Read stock and inventory activity, update inventory, and record stock-in
      and stock-out movements.
    summary: Inventory
    kind: nav
    parent: section-catalog
  - name: Reviews
    description: Read, moderate and remove product reviews.
    summary: Reviews
    kind: nav
    parent: section-catalog
  - name: Media
    description: >-
      Request file uploads, manage uploaded files, and organize them into
      folders.
    summary: Media
    kind: nav
    parent: section-catalog
  - name: Catalog jobs
    description: Create catalog processing jobs and follow their status.
    summary: Catalog jobs
    kind: nav
    parent: section-catalog
  - name: section-customers
    summary: Customers
    kind: nav
  - name: Customers
    description: >-
      Create and update customers, view their details and activity, and manage
      profile images.
    summary: Customers
    kind: nav
    parent: section-customers
  - name: Users
    description: List the users attached to a customer and activate or deactivate them.
    summary: Users
    kind: nav
    parent: section-customers
  - name: Customer attributes
    description: Define customer attributes and manage the values assigned to customers.
    summary: Customer attributes
    kind: nav
    parent: section-customers
  - name: Customer groups
    description: Configure the customer groups available in the store.
    summary: Customer groups
    kind: nav
    parent: section-customers
  - name: Addresses
    description: Read and manage a customer’s saved addresses.
    summary: Addresses
    kind: nav
    parent: section-customers
  - name: Bank accounts
    description: Read and manage a customer’s bank accounts.
    summary: Bank accounts
    kind: nav
    parent: section-customers
  - name: KYC documents
    description: Configure the store’s KYC requirements and manage customer documents.
    summary: KYC documents
    kind: nav
    parent: section-customers
  - name: Visitors
    description: >-
      Read anonymous visitor profiles, their activity and their attribute
      values.
    summary: Visitors
    kind: nav
    parent: section-customers
  - name: Loyalty
    description: >-
      Configure loyalty programs, manage membership tiers, and inspect or record
      point activity.
    summary: Loyalty
    kind: nav
    parent: section-customers
  - name: Credit
    description: Set credit-line eligibility and read customer credit balances.
    summary: Credit
    kind: nav
    parent: section-customers
  - name: Mandates
    description: >-
      Inspect customer payment mandates and debit schedules, and pause, resume
      or revoke a mandate.
    summary: Mandates
    kind: nav
    parent: section-customers
  - name: Segments
    description: >-
      Manage customer segments, their members and associated advertising
      audiences.
    summary: Segments
    kind: nav
    parent: section-customers
  - name: section-shopping
    summary: Shopping
    kind: nav
  - name: Carts
    description: List abandoned carts for follow-up.
    summary: Carts
    kind: nav
    parent: section-shopping
  - name: Subscriptions
    description: Read recurring-purchase subscriptions and their customers.
    summary: Subscriptions
    kind: nav
    parent: section-shopping
  - name: Coupons & promotions
    description: Manage coupons, coupon codes and promotions, and inspect their usage.
    summary: Coupons & promotions
    kind: nav
    parent: section-shopping
  - name: section-orders
    summary: Orders
    kind: nav
  - name: Orders
    description: >-
      Read and update orders, accept or cancel them, check stock, and follow
      order activity.
    summary: Orders
    kind: nav
    parent: section-orders
  - name: Invoices
    description: List order invoices and retrieve an order’s invoice or receipt.
    summary: Invoices
    kind: nav
    parent: section-orders
  - name: Returns
    description: Read customer return requests and approve or reject them.
    summary: Returns
    kind: nav
    parent: section-orders
  - name: Shipments
    description: >-
      Create and manage shipments, follow delivery activity, and handle
      replacements and shortfalls.
    summary: Shipments
    kind: nav
    parent: section-orders
  - name: section-payments
    summary: Payments
    kind: nav
  - name: Order payments
    description: >-
      Create and inspect payment requests, verify order payments, and cancel or
      mark a payment paid.
    summary: Order payments
    kind: nav
    parent: section-payments
  - name: Refunds
    description: Estimate and issue refunds, or mark an order refund paid or forfeited.
    summary: Refunds
    kind: nav
    parent: section-payments
  - name: Payment exceptions
    description: Inspect payment exceptions and resolve them.
    summary: Payment exceptions
    kind: nav
    parent: section-payments
  - name: Payment methods
    description: Configure manual payment methods and list available payment options.
    summary: Payment methods
    kind: nav
    parent: section-payments
  - name: Seller payouts
    description: >-
      Configure seller payouts and manage invoices, adjustments, charges and
      payout batches.
    summary: Seller payouts
    kind: nav
    parent: section-payments
  - name: section-marketplace
    summary: Marketplace
    kind: nav
  - name: Marketplace catalog
    description: Inspect and publish marketplace products, variants, reviews and inventory.
    summary: Marketplace catalog
    kind: nav
    parent: section-marketplace
  - name: Marketplace listings
    description: List, synchronize and remove the store’s product listings on marketplaces.
    summary: Marketplace listings
    kind: nav
    parent: section-marketplace
  - name: Marketplace settings
    description: >-
      Read marketplace configuration and configure category schemas and
      attributes.
    summary: Marketplace settings
    kind: nav
    parent: section-marketplace
  - name: Sellers
    description: Manage the sellers a customer is authorized to buy from.
    summary: Sellers
    kind: nav
    parent: section-marketplace
  - name: section-fulfillment
    summary: Fulfillment
    kind: nav
  - name: Shipping methods
    description: Configure shipping methods and costs, and check courier serviceability.
    summary: Shipping methods
    kind: nav
    parent: section-fulfillment
  - name: Shipping boxes
    description: Manage shipping boxes and read the boxes available for a product.
    summary: Shipping boxes
    kind: nav
    parent: section-fulfillment
  - name: Shipping zones
    description: Create, read and maintain shipping zones.
    summary: Shipping zones
    kind: nav
    parent: section-fulfillment
  - name: Warehouses
    description: Create, read and maintain the store’s warehouses.
    summary: Warehouses
    kind: nav
    parent: section-fulfillment
  - name: section-point-of-sale
    summary: Point of sale
    kind: nav
  - name: Devices
    description: Manage POS devices, generate pairing codes and revoke devices.
    summary: Devices
    kind: nav
    parent: section-point-of-sale
  - name: POS users
    description: Manage staff accounts used at the point of sale.
    summary: Staff
    kind: nav
    parent: section-point-of-sale
  - name: POS roles
    description: Manage POS roles and inspect available permissions.
    summary: Roles & permissions
    kind: nav
    parent: section-point-of-sale
  - name: section-store
    summary: Store
    kind: nav
  - name: Store
    description: Read and update the store configuration.
    summary: Store
    kind: nav
    parent: section-store
  - name: Locations
    description: List countries, states and pincodes.
    summary: Locations
    kind: nav
    parent: section-store
  - name: Notifications
    description: >-
      Manage notification templates and store or customer notification
      preferences.
    summary: Notifications
    kind: nav
    parent: section-store
  - name: Downloads
    description: Request data downloads and follow download jobs.
    summary: Downloads
    kind: nav
    parent: section-store
  - name: Search
    description: Search customers, orders and products across the store.
    summary: Search
    kind: nav
    parent: section-store
  - name: Filter options
    description: >-
      Retrieve the available filters for resource lists in the administration
      interface.
    summary: Filter options
    kind: nav
    parent: section-store
  - name: section-integrations
    summary: Integrations
    kind: nav
  - name: Catalog integrations
    description: Request catalog synchronization and inspect sync results and activity.
    summary: Catalog integrations
    kind: nav
    parent: section-integrations
  - name: Service providers
    description: Configure service providers and test their connections.
    summary: Service providers
    kind: nav
    parent: section-integrations
  - name: Webhooks
    description: >-
      Manage webhook subscriptions, rotate their secrets and send test
      deliveries.
    summary: Webhooks
    kind: nav
    parent: section-integrations
  - name: Webhook deliveries
    description: >-
      Inspect webhook delivery logs, retry deliveries and replay events to a
      subscription.
    summary: Webhook deliveries
    kind: nav
    parent: section-integrations
  - name: Events
    description: >-
      Browse recorded events and the event types available for webhook
      subscriptions.
    summary: Events
    kind: nav
    parent: section-integrations
  - name: Live updates
    description: Read the store’s live event stream and global state.
    summary: Live updates
    kind: nav
    parent: section-integrations
  - name: section-analytics
    summary: Analytics
    kind: nav
  - name: Analytics
    description: Query analytics data, read charts and inspect visitor sessions and events.
    summary: Analytics
    kind: nav
    parent: section-analytics
  - name: Metrics
    description: >-
      Read aggregate metrics for catalog, customers, orders, payments,
      fulfillment and webhooks.
    summary: Metrics
    kind: nav
    parent: section-analytics
paths:
  /customers/loyalty-program/{id}/pause:
    put:
      tags:
        - Loyalty
      summary: Pause loyalty program
      description: >-
        Pauses the loyalty program, setting its status to `paused`. Can only be
        used when the current status is `active` or `paused`. Returns the
        updated `LoyaltyProgram` object.
      operationId: pause-loyalty-program
      parameters:
        - name: id
          in: path
          description: loyalty program id
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                pause_starts_at:
                  description: >-
                    When to start the pause. If not specified, pauses
                    immediately.
                  type: string
                  format: date-time
                pause_ends_at:
                  description: >-
                    When to end the pause. If not specified, remains paused
                    until resumed.
                  type: string
                  format: date-time
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  success:
                    type: boolean
                  content:
                    properties:
                      loyalty_program:
                        $ref: '#/components/schemas/LoyaltyProgram'
                    type: object
components:
  schemas:
    LoyaltyProgram:
      title: LoyaltyProgram
      type: object
      required:
        - name
        - renewal_type
        - starts_at
        - date_of_reset
        - tier_upgrade_criteria
        - points_earning_type
        - point_value
        - redemption_expiry_type
        - redemption_inactivity_days
        - tiers
      properties:
        id:
          type: string
          readOnly: true
        name:
          description: name of loyalty program
          type: string
        seller_id:
          description: >-
            Restricts the program to these sellers. Use `null` or omit to apply
            it across all sellers.
          type:
            - array
            - 'null'
          items:
            type: string
        customer_group_id:
          description: >-
            Restricts the program to these customer groups. Use `null` or omit
            to apply it to all customers.
          type:
            - array
            - 'null'
          items:
            type: string
        renewal_type:
          description: frequency at which loyalty program will be renewed.
          enum:
            - yearly
            - never
            - custom
        starts_at:
          description: >-
            If renewal_type is "custom", a corresponding valid date must be
            specified; for other types, the value should be null.
          type:
            - string
            - 'null'
          format: date-time
        date_of_reset:
          description: >-
            If renewal_type is "custom", a corresponding valid date must be
            specified; for other types, the value should be null.
          type:
            - string
            - 'null'
          format: date
        tier_upgrade_criteria:
          description: >-
            to decide tier upgradation based on no of orders or total purchase
            value
          enum:
            - total-spent
            - total-orders
            - custom
        points_earning_type:
          description: >-
            Defines how points are earned. "dynamic" means points are calculated
            based on a rate (points_earning_rate), "fixed" means a fixed number
            of points are given.
          enum:
            - dynamic
            - fixed
        point_value:
          description: The monetary value of one loyalty point.
          type: number
          default: 1
        redemption_expiry_type:
          description: >-
            Defines when loyalty points are expired. "never" means the points
            never expire, "inactivity" means the points expire after a certain
            number of days of inactivity, "reset_date" means the points expire
            when the loyalty program is reset.
          enum:
            - never
            - inactivity
            - reset_date
        redemption_inactivity_days:
          description: >-
            The number of days after the last order was placed, after which the
            points expire if redemption_expiry_type is "inactivity". required if
            redemption_expiry_type is "inactivity", otherwise should be null.
          type:
            - integer
            - 'null'
        status:
          $ref: '#/components/schemas/LoyaltyProgramStatus'
          readOnly: true
        pause_starts_at:
          description: >-
            If status is "paused", the date and time from which the loyalty
            program will be paused. If not specified, the loyalty program will
            be paused immediately.
          type:
            - string
            - 'null'
          format: date-time
        pause_ends_at:
          description: >-
            If status is "paused", the date and time until which the loyalty
            program will be paused. If not specified, the loyalty program will
            remain paused until it is resumed.
          type:
            - string
            - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
          readOnly: true
        modified_at:
          type: string
          format: date-time
          readOnly: true
        tiers:
          type: array
          items:
            $ref: '#/components/schemas/LoyaltyTier'
      x-tags:
        - Customers
    LoyaltyProgramStatus:
      title: LoyaltyProgramStatus
      description: The operational status of the loyalty program.
      type: string
      enum:
        - draft
        - scheduled
        - active
        - inactive
        - paused
        - expired
    LoyaltyTier:
      title: LoyaltyTier
      type: object
      required:
        - name
        - total_spent_threshold
        - total_orders_threshold
        - points_earning_rate
        - fixed_points
      properties:
        id:
          type: string
          readOnly: true
        name:
          description: name of loyalty tier
          type: string
        total_spent_threshold:
          description: It should be null if tier upgrade criteria is total orders only.
          type:
            - integer
            - 'null'
          minimum: 0
        total_orders_threshold:
          description: It should be null if tier upgrade criteria is total spent only.
          type:
            - integer
            - 'null'
          minimum: 0
        points_earning_rate:
          description: >-
            The rate at which points are earned. For point earning type =
            dynamic
          type:
            - number
            - 'null'
        fixed_points:
          description: Fixed loyalty points for all orders. For point earning type = fixed
          type:
            - integer
            - 'null'
        is_initial:
          description: only one tier will have value as True
          type: boolean
          readOnly: true
        next_tier_id:
          description: id of next loyalty tier
          type:
            - string
            - 'null'
          readOnly: true
      x-tags:
        - Customers
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.