Solvimon promotionCodes API
The promotionCodes API from Solvimon — 7 operation(s) for promotioncodes.
The promotionCodes API from Solvimon — 7 operation(s) for promotioncodes.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/solvimon-promotioncodes-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
info:
title: Configuration alertRules Promotion Codes API
version: 1.0.0
servers:
- url: https://test.api.solvimon.com
description: The TEST environment for our API
- url: https://api.solvimon.com
description: The live environment for our API
tags:
- name: promotionCodes
paths:
/v{version}/promotion-codes:
get:
operationId: getPromotionCodes
summary: Get promotion codes
description: Requires the PROMOTION_CODE.VIEW permission.
tags:
- promotionCodes
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: coupon_id
in: query
description: Filter by coupon id.
required: false
schema:
type: string
- name: statuses[]
in: query
description: Filter by promotion code status.
required: false
schema:
type: array
items:
type: string
- name: expand[]
in: query
description: The id fields of the resources that are going to be expanded.
required: false
schema:
type: array
items:
type: string
- name: limit
in: query
description: The amount of records shown in the list.
required: false
schema:
type: integer
- name: page
in: query
description: The page which is going to be shown.
required: false
schema:
type: integer
- name: order_by
in: query
description: The parameter by which the response is ordered.
required: false
schema:
type: string
- name: order_direction
in: query
description: The order direction by which the response is ordered.
required: false
schema:
type: string
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PromotionCodeResponseWrapper'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
post:
operationId: postPromotionCodes
summary: Create a promotion code
description: Requires the PROMOTION_CODE.CREATE permission.
tags:
- promotionCodes
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/PromotionCode'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PromotionCodeCreateRequest'
/v{version}/promotion-codes/{resourceIdOrReference}:
get:
operationId: getPromotionCodesByResourceIdOrReference
summary: Get a promotion code
description: Requires the PROMOTION_CODE.VIEW permission.
tags:
- promotionCodes
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceIdOrReference
in: path
description: The ID or reference of the resource.
required: true
schema:
type: string
default: ''
- name: expand[]
in: query
description: The id fields of the resources that are going to be expanded.
required: false
schema:
type: array
items:
type: string
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PromotionCode'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/v{version}/promotion-codes/{resourceIdOrReference}/redemptions:
get:
operationId: getPromotionCodesByResourceIdOrReferenceRedemptions
summary: Get a list of promotion code redemptions
description: Requires the PROMOTION_CODE.VIEW permission.
tags:
- promotionCodes
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceIdOrReference
in: path
description: The id of the promotion code or the code itself.
required: true
schema:
type: string
default: ''
- name: customer_id
in: query
description: Filter by customer id.
required: false
schema:
type: string
- name: pricing_plan_subscription_id
in: query
description: Filter by pricing plan subscription id.
required: false
schema:
type: string
- name: limit
in: query
description: The amount of records shown in the list.
required: false
schema:
type: integer
- name: page
in: query
description: The page which is going to be shown.
required: false
schema:
type: integer
- name: order_by
in: query
description: The parameter by which the response is ordered.
required: false
schema:
type: string
- name: order_direction
in: query
description: The order direction by which the response is ordered.
required: false
schema:
type: string
- name: expand[]
in: query
description: The id fields of the resources that are going to be expanded.
required: false
schema:
type: array
items:
type: string
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CouponRedemptionResponseWrapper'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/v{version}/promotion-codes/{resourceIdOrReference}/activate:
post:
operationId: postPromotionCodesByResourceIdOrReferenceActivate
summary: Activate a promotion code
tags:
- promotionCodes
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceIdOrReference
in: path
description: The ID or reference of the resource.
required: true
schema:
type: string
default: ''
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PromotionCode'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/v{version}/promotion-codes/{resourceIdOrReference}/deactivate:
post:
operationId: postPromotionCodesByResourceIdOrReferenceDeactivate
summary: Deactivate a promotion code
tags:
- promotionCodes
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceIdOrReference
in: path
description: The ID or reference of the resource.
required: true
schema:
type: string
default: ''
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PromotionCode'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/v{version}/promotion-codes/{resourceIdOrReference}/deprecate:
post:
operationId: postPromotionCodesByResourceIdOrReferenceDeprecate
summary: Deprecate a promotion code
tags:
- promotionCodes
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceIdOrReference
in: path
description: The ID or reference of the resource.
required: true
schema:
type: string
default: ''
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PromotionCode'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/v{version}/promotion-codes/{resourceIdOrReference}/archive:
post:
operationId: postPromotionCodesByResourceIdOrReferenceArchive
summary: Archive a promotion code
tags:
- promotionCodes
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceIdOrReference
in: path
description: The ID or reference of the resource.
required: true
schema:
type: string
default: ''
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PromotionCode'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
components:
schemas:
PromotionCode:
type: object
properties:
object_type:
type:
- string
- 'null'
id:
type:
- string
- 'null'
code_format:
type: string
code:
type: string
coupon_id:
type: string
status:
oneOf:
- $ref: '#/components/schemas/PromotionCodeStatus'
- type: 'null'
limited_to:
$ref: '#/components/schemas/PromotionCodeLimitedTo'
start_at:
type:
- string
- 'null'
end_at:
type:
- string
- 'null'
maximum_redemptions:
type:
- integer
- 'null'
number_of_redemptions:
type:
- integer
- 'null'
created_at:
type:
- string
- 'null'
updated_at:
type:
- string
- 'null'
title: PromotionCode
EInvoicingIntegrationProcessor:
type: string
enum:
- AVALARA
title: EInvoicingIntegrationProcessor
TotalDiscount:
type: object
properties:
start_at:
type:
- string
- 'null'
end_at:
type:
- string
- 'null'
amount:
$ref: '#/components/schemas/Amount'
percentage:
type:
- string
- 'null'
coupon_id:
type:
- string
- 'null'
description: Resource ID of type COUPON
promotion_code_details:
oneOf:
- $ref: '#/components/schemas/PromotionCodeDetails'
- type: 'null'
condition:
$ref: '#/components/schemas/DiscountCondition'
title: TotalDiscount
CustomerRolesItems:
type: string
enum:
- DEFAULT
- NON_PROCESSING
- SELF_BILLING
- SELLER
- PROCESSING_ONLY
title: CustomerRolesItems
Individual:
type: object
properties:
name:
$ref: '#/components/schemas/Name'
residential_address:
$ref: '#/components/schemas/Address'
title: Individual
PaymentGatewayPaymentAcceptor:
type: object
properties:
integration_id:
type: string
description: Resource ID of type INTEGRATION
integration:
oneOf:
- $ref: '#/components/schemas/Integration'
- type: 'null'
store_payment_method:
type:
- boolean
- 'null'
auto_charge_payment_method:
type:
- boolean
- 'null'
collection_type:
$ref: '#/components/schemas/PaymentGatewayPaymentAcceptorCollectionType'
link:
$ref: '#/components/schemas/PaymentGatewayPaymentAcceptorLink'
adyen:
$ref: '#/components/schemas/PaymentGatewayPaymentAcceptorAdyen'
title: PaymentGatewayPaymentAcceptor
TemplatePricingPlanSubscription:
type: object
properties:
apply_billing_entity_selector:
type:
- boolean
- 'null'
allow_promotion_codes:
oneOf:
- $ref: '#/components/schemas/TemplatePricingPlanSubscriptionAllowPromotionCodes'
- type: 'null'
title: TemplatePricingPlanSubscription
PricingPlanSubscriptionGroup:
type: object
properties:
object_type:
type:
- string
- 'null'
id:
type:
- string
- 'null'
reference:
type: string
description: Unique reference for this subscription group
name:
type:
- string
- 'null'
description: Optional name for this subscription group
description:
type:
- string
- 'null'
description: Optional description for this subscription group
owner_customer_id:
type:
- string
- 'null'
description: When provided, this subscription group can only be used for the customer that is linked to this ID and children of that customer
owner_customer:
oneOf:
- $ref: '#/components/schemas/Customer'
- type: 'null'
pricing_plan_subscription_ids:
type:
- array
- 'null'
items:
type: string
title: PricingPlanSubscriptionGroup
ProductItemDiscount:
type: object
properties:
ids:
type: array
items:
type: string
description: Resource ID of type PRODUCT_ITEM
start_at:
type:
- string
- 'null'
end_at:
type:
- string
- 'null'
amount:
$ref: '#/components/schemas/Amount'
percentage:
type:
- string
- 'null'
coupon_id:
type:
- string
- 'null'
description: Resource ID of type COUPON
promotion_code_details:
oneOf:
- $ref: '#/components/schemas/PromotionCodeDetails'
- type: 'null'
condition:
$ref: '#/components/schemas/DiscountCondition'
title: ProductItemDiscount
ApiError:
type: object
properties:
type:
$ref: '#/components/schemas/ApiErrorType'
code:
$ref: '#/components/schemas/ApiErrorCode'
field:
type:
- string
- 'null'
message:
type: string
resource_id:
type:
- string
- 'null'
resource_type:
oneOf:
- $ref: '#/components/schemas/ApiErrorResourceType'
- type: 'null'
required:
- type
- code
- message
title: ApiError
WalletTypeStatus:
type: string
enum:
- DRAFT
- ACTIVE
- INACTIVE
- DEPRECATED
- ARCHIVED
title: WalletTypeStatus
PricingDiscount:
type: object
properties:
ids:
type: array
items:
type: string
description: Resource ID of type PRICING
start_at:
type:
- string
- 'null'
format: date-time
end_at:
type:
- string
- 'null'
format: date-time
amount:
$ref: '#/components/schemas/Amount'
percentage:
type:
- string
- 'null'
condition:
$ref: '#/components/schemas/DiscountCondition'
title: PricingDiscount
PricingItemConfig:
type: object
properties:
object_type:
type:
- string
- 'null'
id:
type:
- string
- 'null'
description: Resource ID of type PRICING_ITEM_CONFIG
original_pricing_item_config_id:
type:
- string
- 'null'
original_pricing_item_config:
oneOf:
- $ref: '#/components/schemas/PricingItemConfigOriginalPricingItemConfig'
- type: 'null'
description: This property creates a circular reference in the `PricingItemConfig` schema. If you experience any issues with OpenAPI tools related to these circular references, you can try removing this property from the specification.
details:
$ref: '#/components/schemas/PricingItemConfigDetails'
billing_period:
$ref: '#/components/schemas/Period'
type:
oneOf:
- $ref: '#/components/schemas/PricingItemConfigType'
- type: 'null'
pricing_type:
oneOf:
- $ref: '#/components/schemas/PricingItemConfigPricingType'
- type: 'null'
pricing_period:
$ref: '#/components/schemas/Period'
default_included_volume:
$ref: '#/components/schemas/PricingItemConfigMeterValueIncludedVolume'
default_seats_value:
$ref: '#/components/schemas/PricingItemConfigMeterValue'
conditions:
$ref: '#/components/schemas/PricingItemConfigConditions'
tiering_conditions:
$ref: '#/components/schemas/MeterConditions'
description: Conditions that filter for which `TIERING` events this pricing item config is applied. Only the `expression` is supported here; the deprecated `meter_properties` field is not allowed.
bands:
type: array
items:
$ref: '#/components/schemas/PricingItemConfigBand'
order:
type:
- integer
- 'null'
billing_in_advance:
type:
- boolean
- 'null'
volume_group_reference:
type:
- string
- 'null'
top_up:
$ref: '#/components/schemas/PricingItemConfigTopUp'
split_pricing:
$ref: '#/components/schemas/PricingItemConfigSplitPricing'
on_demand:
type:
- boolean
- 'null'
wallet_grants:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/PricingItemConfigWalletGrant'
title: PricingItemConfig
WalletTypeCredit:
type: object
properties:
grant_type:
$ref: '#/components/schemas/WalletTypeCreditGrantType'
amount_grant:
$ref: '#/components/schemas/WalletTypeCreditAmountGrant'
credits_grant:
$ref: '#/components/schemas/WalletTypeCreditCreditsGrant'
title: WalletTypeCredit
PricingItemDiscount:
type: object
properties:
ids:
type: array
items:
type: string
description: Resource ID of type PRICING_ITEM
start_at:
type:
- string
- 'null'
format: date-time
end_at:
type:
- string
- 'null'
format: date-time
amount:
$ref: '#/components/schemas/Amount'
percentage:
type:
- string
- 'null'
condition:
$ref: '#/components/schemas/DiscountCondition'
title: PricingItemDiscount
AdyenPaymentGatewayIntegrationEnvironment:
type: string
enum:
- LIVE
- TEST
title: AdyenPaymentGatewayIntegrationEnvironment
PricingPlanVersionStatus:
type: string
enum:
- DRAFT
- ACTIVE
- ARCHIVED
- DEPRECATED
title: PricingPlanVersionStatus
Pricing:
type: object
properties:
object_type:
type:
- string
- 'null'
id:
type:
- string
- 'null'
pricing_plan_version_id:
type:
- string
- 'null'
description: Resource ID of type PRICING_PLAN_VERSION
pricing_plan_schedule_id:
type:
- string
- 'null'
description: Resource ID of type PRICING_PLAN_SCHEDULE
pricing_group_id:
type:
- string
- 'null'
description: Resource ID of type PRICING_GROUP
original_pricing_id:
type:
- string
- 'null'
original_pricing:
oneOf:
- $ref: '#/components/schemas/PricingOriginalPricing'
- type: 'null'
description: This property creates a circular reference in the `Pricing` schema. If you experience any issues with OpenAPI tools related to these circular references, you can try removing this property from the specification.
override:
oneOf:
- $ref: '#/components/schemas/PricingOverride'
- type: 'null'
name:
type:
- string
- 'null'
product_type:
oneOf:
- $ref: '#/components/schemas/PricingProductType'
- type: 'null'
product_ids:
type: array
items:
type: string
display_order:
type:
- integer
- 'null'
products:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Product'
entitlements:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Entitlement'
items:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/PricingItem'
title: Pricing
NotificationPreference:
type: object
properties:
type:
$ref: '#/components/schemas/NotificationPreferenceType'
description: The notification type to configure.
channels:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/NotificationChannel'
description: The channels for this notification type.
title: NotificationPreference
DiscountConditionComparator:
type: string
enum:
- EQUALS
- NOT_EQUALS
- IN
- NOT_IN
- GREATER_THAN
- GREATER_THAN_OR_EQUALS
- LESS_THAN
- LESS_THAN_OR_EQUALS
- EMPTY
- NOT_EMPTY
- CONTAINS
- NOT_CONTAINS
title: DiscountConditionComparator
CustomerType:
type: string
enum:
- ORGANIZATION
- INDIVIDUAL
description: The type of customer entity.
title: CustomerType
IntegrationType:
type: string
enum:
- PAYMENT_GATEWAY
- E_INVOICING
- TAX_CALCULATION
- DATA_EXPORT
- EMAIL_PROVIDER
description: The type of integration.
title: IntegrationType
PricingItemPricingCurrencyConfigFallbackCurrency:
type: string
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BRL
- BSD
- BTN
- BWP
- BYN
- BZD
- CAD
- CDF
- CHF
- CLF
- CLP
- CNY
- COP
- CRC
- CUC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- INR
- IQD
- IRR
- ISK
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRO
- MRU
- MUR
- MVR
- MWK
- MXN
- MXV
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLE
- SOS
- SRD
- SSP
- STN
- SVC
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- USD
- USN
- UYI
- UYU
- UZS
- VEF
- VES
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XBA
- XBB
- XBC
- XBD
- XCD
- XDR
- XOF
- XPD
- XPF
- XPT
-
# --- truncated at 32 KB (170 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/solvimon/refs/heads/main/openapi/solvimon-promotioncodes-api-openapi.yml