> ## Documentation Index
> Fetch the complete documentation index at: https://developer.fabric.inc/llms.txt
> Use this file to discover all available pages before exploring further.
# Update a subscription discount
> Update a subscription discount for a specified offer (specified by offer ID)
## OpenAPI
````yaml smt put /v1/subscriptionDiscount/{offerId}
openapi: 3.0.0
info:
title: Subscriptions (SMT API)
description: >-
fabric's Subscriptions API lets your customers set recurring purchases of
their desired products or services for a scheduled period (weekly, monthly,
etc.). In addition, Subscriptions helps you retrieve and update subscription
details, and lets your customers skip one or more subscription schedules, or
remove a subscription. This API also lets you create and updates customers
cancellation reasons, and subscription discounts.
version: 2.0.0
contact:
email: support@fabric.inc
license:
name: fabric API License
url: https://fabric.inc/api-license
servers:
- url: https://prod01.copilot.fabric.inc/data-subscription
description: Production
security:
- bearerAuth: []
tags:
- name: Subscribers
description: >-
These endpoints let you create, update, or get one or all of your
subscribers (customers who have subscriptions). If you request all
subscribers, you will receive a paginated response; you can specify the
page size, and which page you want.
- name: Subscriptions
description: >-
These endpoints let your customers set recurring purchases of their
desired products or services for a scheduled period (weekly, monthly,
etc.). In addition, these endpoints let you get and update subscription
details, and let your customers skip one or more subscription schedules,
or remove a subscription.
- name: Orders
description: >-
These endpoints let your customers purchase products and services from
your store.
- name: Cancellation Reasons
description: These endpoints let you create and get cancellation reasons.
- name: Subscription Discounts
description: >-
These endpoints let you create, update, deactivate, and get discount
offers for the orders placed by your customers.
paths:
/v1/subscriptionDiscount/{offerId}:
put:
tags:
- Subscription Discounts
summary: Update a subscription discount
description: >-
Update a subscription discount for a specified offer (specified by offer
ID)
operationId: updateDiscount
parameters:
- in: path
name: offerId
required: true
description: Offer ID
schema:
$ref: '#/components/schemas/Id'
requestBody:
description: Details used to update discount
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDiscountRequest'
responses:
'200':
description: Request processed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDiscountResponse'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/badRequestError'
'403':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/unAuthError'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/notFoundError'
components:
schemas:
Id:
type: string
description: General object ID
example: 606f01f441b8fc0008529916
UpdateDiscountRequest:
type: object
description: Details used to update discount
properties:
discount:
$ref: '#/components/schemas/Discount'
message:
type: string
description: Merchant discount message
example: Offer terms and conditions
skus:
type: array
description: SKUs
items:
type: string
description: SKU
example: MOBO-X570
categories:
type: array
description: Product categories
items:
type: string
description: Product category
example: holiday-best-sellers
frequency:
$ref: '#/components/schemas/Frequency'
itemQuantity:
type: integer
description: Number of items
example: 1
channel:
type: string
description: Channel
example: WEBSITE
enum:
- WEBSITE
- POS
target:
type: string
description: Discount target
example: PDP
enum:
- PDP
- CART
- QUICK VIEW
- SUBSCRIPTION MANAGEMENT PORTAL
UpdateDiscountResponse:
type: object
description: Discount details after update
properties:
responseStatus:
description: Brief response status
type: string
example: OK
message:
description: Full response message
type: string
example: Request processed successfully
data:
description: Discount details
type: object
properties:
id:
type: string
description: Discount ID
example: 62d9196aeec12800095633f2
status:
type: string
description: Discount status
example: ACTIVE
enum:
- ACTIVE
- INACTIVE
offerCode:
type: string
description: Offer code
example: SUB-D45DD7
validity:
$ref: '#/components/schemas/Validity'
message:
type: string
description: Merchant discount message
example: Offer terms and conditions
discount:
$ref: '#/components/schemas/Discount'
skus:
type: array
description: SKUs
items:
type: string
description: SKU
example: MOBO-X570
categories:
type: array
description: Product categories
items:
type: string
description: Product category
example: holiday-best-sellers
frequency:
$ref: '#/components/schemas/Frequency'
itemQuantity:
type: integer
description: Number of items
example: 1
channel:
type: string
description: Channel
example: WEBSITE
enum:
- WEBSITE
- POS
target:
type: string
description: Discount target
example: PDP
enum:
- PDP
- CART
- QUICK VIEW
- SUBSCRIPTION MANAGEMENT PORTAL
customerSegment:
type: array
description: Customer segments
items:
type: string
description: Customer segment
example: employee
isDeleted:
type: boolean
description: 'true: Customer is deleted
false: Customer is not deleted'
example: false
DeletedAt:
type: string
description: >-
If `isDeleted`=true, time at which the customer was deleted
If `isDeleted`=false, NULL
example: '2019-01-01T00:00:00.000Z'
createdAt:
type: string
description: Time customer was created
example: '2021-10-12T21:35:05.756Z'
updatedAt:
type: string
description: Most recent time customer was updated
example: '2021-10-14T05:40:55.997Z'
badRequestError:
type: object
description: Bad request error
properties:
responseStatus:
type: string
description: Brief response status
example: BAD_REQUEST
message:
type: string
description: Full response message
example: Bad request
unAuthError:
type: object
description: Unauthenticated error
properties:
Message:
description: Full response message
example: User is not authorized to access this resource with an explicit deny
type: string
notFoundError:
type: object
description: Not found
properties:
responseStatus:
description: Brief response status
type: string
example: NOT_FOUND
message:
description: Full response message
type: string
example: Not found
Discount:
type: object
description: Discount detail
properties:
amount:
type: number
description: Discount amount
example: 10
Frequency:
type: object
description: Shipping frequency details
properties:
shippingFrequency:
type: integer
description: Shipping frequency
example: 1
shippingFrequencyType:
type: string
description: Shipping frequency period
example: daily
enum:
- daily
- weekly
- monthly
- yearly
billingFrequency:
type: integer
description: Billing frequency
example: 1
billingFrequencyType:
type: string
description: Billing frequency period
example: daily
enum:
- daily
- weekly
- monthly
- yearly
Validity:
type: object
description: >-
Dates during which discount is valid, and orders to which discount
applies
properties:
startDate:
type: string
description: Validity start date
example: '2022-07-21T13:14:51.474Z'
endDate:
type: string
description: Validity end date
example: '2022-07-21T13:14:51.474Z'
applyOnOrders:
type: array
description: Orders to which discount applies
example:
- 2
- 3
items:
type: integer
description: Order numbers to which discount applies
example: 2
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
````