Solvimon pricingPlanSchedules API
The pricingPlanSchedules API from Solvimon — 5 operation(s) for pricingplanschedules.
The pricingPlanSchedules API from Solvimon — 5 operation(s) for pricingplanschedules.
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-pricingplanschedules-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 Pricing Plan Schedules 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: pricingPlanSchedules
paths:
/v{version}/pricing-plan-schedules:
get:
operationId: getPricingPlanSchedules
summary: Get a list of PricingPlanSchedules for provided filters
description: Requires the PRICING_PLAN_SCHEDULE.VIEW or QUOTE.PRICING_PLAN_SCHEDULE.VIEW permission.
tags:
- pricingPlanSchedules
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: pricing_plan_subscription_id
in: query
description: The resource id of the pricingPlanSubscription.
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/PricingPlanScheduleResponseWrapper'
'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: postPricingPlanSchedules
summary: Create a pricing plan schedule
description: Requires the PRICING_PLAN_SCHEDULE.CREATE or QUOTE.PRICING_PLAN_SCHEDULE.CREATE permission.
tags:
- pricingPlanSchedules
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- 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: set_previous_end_at
in: query
description: Setting the value to true will set the end_at of the previous schedule to the start_at of this schedule. Mutually exclusive with set_next_start_at
required: false
schema:
type: boolean
- name: set_next_start_at
in: query
description: Setting the value to true will set the start_at of the next schedule to the end_at of this schedule. Mutually exclusive with set_previous_end_at
required: false
schema:
type: boolean
- 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/PricingPlanSchedule'
'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'
'409':
description: Conflict
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/PricingPlanScheduleCreateRequest'
/v{version}/pricing-plan-schedules/{resourceId}:
get:
operationId: getPricingPlanSchedulesByResourceId
summary: Get a pricingPlanSchedule by resourceID
description: Requires the PRICING_PLAN_SCHEDULE.VIEW or QUOTE.PRICING_PLAN_SCHEDULE.VIEW permission.
tags:
- pricingPlanSchedules
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceId
in: path
description: The ID of the resource to be requested.
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: include_combined_pricing_plan_version
in: query
description: Get the pricing plan version with the pricing overrides.
required: false
schema:
type: boolean
- 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/PricingPlanSchedule'
'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'
delete:
operationId: deletePricingPlanSchedulesByResourceId
summary: Delete a pricingPlanSchedule by resource ID
description: Requires the PRICING_PLAN_SCHEDULE.DELETE permission.
tags:
- pricingPlanSchedules
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceId
in: path
description: The ID of the resource to be requested.
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/PricingPlanSchedule'
'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'
patch:
operationId: patchPricingPlanSchedulesByResourceId
summary: Update a pricingPlanSchedule
description: Requires the PRICING_PLAN_SCHEDULE.UPDATE or QUOTE.PRICING_PLAN_SCHEDULE.UPDATE permission.
tags:
- pricingPlanSchedules
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceId
in: path
description: The ID of the resource to be requested.
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: set_previous_end_at
in: query
description: Setting the value to true will set the end of the previous schedule to the start of this schedule. Mutually exclusive with set_next_start_at
required: false
schema:
type: boolean
- name: set_next_start_at
in: query
description: Setting the value to true will set the start of the next schedule to the end of this schedule. Mutually exclusive with set_previous_end_at
required: false
schema:
type: boolean
- 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/PricingPlanSchedule'
'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/PricingPlanScheduleUpdateRequest'
/v{version}/pricing-plan-schedules/{resourceId}/on-demand-pricing-items:
get:
operationId: getPricingPlanSchedulesByResourceIdOnDemandPricingItems
summary: Get all available on demand pricing items for a pricing plan schedule
description: Requires the PRICING_PLAN_SCHEDULE.VIEW or QUOTE.PRICING_PLAN_SCHEDULE.VIEW permission.
tags:
- pricingPlanSchedules
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceId
in: path
description: The ID of the resource to be requested.
required: true
schema:
type: string
default: ''
- name: timestamp
in: query
description: Timestamp used to resolve the applicable pricing plan version for rate-card schedules. Defaults to now.
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/OnDemandPricingItemsResponse'
'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}/pricing-plan-schedules/{resourceId}/copy:
post:
operationId: postPricingPlanSchedulesByResourceIdCopy
summary: Copy a pricing plan schedule
description: Requires the PRICING_PLAN_SCHEDULE.CREATE permission.
tags:
- pricingPlanSchedules
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceId
in: path
description: The ID of the resource to be requested.
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: set_previous_end_at
in: query
description: Setting the value to true will set the end of the previous schedule to the start of this schedule. Mutually exclusive with set_next_start_at
required: false
schema:
type: boolean
- name: set_next_start_at
in: query
description: Setting the value to true will set the start of the next schedule to the end of this schedule. Mutually exclusive with set_previous_end_at
required: false
schema:
type: boolean
- 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/PricingPlanSchedule'
'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'
'409':
description: Conflict
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/PricingPlanScheduleCopyCreateRequest'
/v{version}/pricing-plan-schedules/{resourceId}/migrate:
post:
operationId: postPricingPlanSchedulesByResourceIdMigrate
summary: Migrate a pricing plan schedule to a new pricing plan version
description: Requires the PRICING_PLAN_SCHEDULE.CREATE permission.
tags:
- pricingPlanSchedules
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceId
in: path
description: The ID of the resource to be requested.
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: set_previous_end_at
in: query
description: Setting the value to true will set the end of the previous schedule to the start of this schedule. Mutually exclusive with set_next_start_at
required: false
schema:
type: boolean
- 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/PricingPlanSchedule'
'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'
'409':
description: Conflict
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/PricingPlanScheduleMigrateCreateRequest'
components:
schemas:
PricingPlanScheduleUpdateRequest:
type: object
properties:
object_type:
type:
- string
- 'null'
id:
type:
- string
- 'null'
type:
oneOf:
- $ref: '#/components/schemas/PricingPlanScheduleUpdateRequestType'
- type: 'null'
description: The type of the pricing plan schedule.
pricing_plan_subscription_id:
type: string
description: Resource ID of type PRICING_PLAN_SUBSCRIPTION
pricing_plan_id:
type:
- string
- 'null'
description: The resource ID of the pricing plan.
pricing_plan_version_id:
type:
- string
- 'null'
description: The resource ID of the pricing plan version.
pricing_plan_version_selector:
$ref: '#/components/schemas/PricingPlanVersionSelectorUpdateRequest'
description: Instead of the pricing_plan_version_id, during creation, a selector can be submitted to determine the pricing plan version.
start_at:
type: string
format: date-time
end_at:
type:
- string
- 'null'
format: date-time
pricing_currency:
oneOf:
- $ref: '#/components/schemas/PricingPlanScheduleUpdateRequestPricingCurrency'
- type: 'null'
description: The default alphabetic currency code representing the type of currency used for the pricing.
billing_period:
$ref: '#/components/schemas/PeriodUpdateRequest'
entitlements:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/EntitlementUpdateRequest'
discount:
$ref: '#/components/schemas/DiscountUpdateRequest'
markup:
$ref: '#/components/schemas/MarkupUpdateRequest'
commitment:
$ref: '#/components/schemas/CommitmentUpdateRequest'
promotion_codes:
type:
- array
- 'null'
items:
type: string
coupon_ids:
type:
- array
- 'null'
items:
type: string
coupon_discount:
oneOf:
- $ref: '#/components/schemas/DiscountUpdateRequest'
- type: 'null'
coupons:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/AppliedCouponUpdateRequest'
seats_values:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ConfiguredMeterValueUpdateRequest'
included_volumes:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ConfiguredMeterValueIncludedVolumeUpdateRequest'
enabled_pricings:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/EnabledPricingUpdateRequest'
override_pricings:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/PricingUpdateRequest'
pricing_categories:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/PricingCategoryUpdateRequest'
description: Pricing defined directly on this schedule, in addition to (or instead of) a linked pricing plan version / rate-card.
combined_pricing_plan_version:
oneOf:
- $ref: '#/components/schemas/PricingPlanVersionUpdateRequest'
- type: 'null'
realign_invoice_date_to_pricing_plan_schedule_start_at:
type:
- boolean
- 'null'
created_at:
type:
- string
- 'null'
title: PricingPlanScheduleUpdateRequest
PricingPlanScheduleUpdateRequestPricingCurrency:
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
- XSU
- XTS
- XUA
- XXX
- YER
- ZAR
- ZMW
- ZWL
description: The default alphabetic currency code representing the type of currency used for the pricing.
title: PricingPlanScheduleUpdateRequestPricingCurrency
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
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
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
PricingPlanVersionSelectorUpdateRequestType:
type: string
enum:
- LATEST
- VERSION
description: The type of the selector to determine pricing plan version (by default LATEST).
title: PricingPlanVersionSelectorUpdateRequestType
PeriodUpdateRequestType:
type: string
enum:
- DAY
- WEEK
- MONTH
- YEAR
title: PeriodUpdateRequestType
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
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
WalletTypeCredit:
type: object
properties:
grant_type:
$ref: '#/components/schemas/WalletTypeCreditGrantType'
amount_grant:
$ref: '#/components/schemas/WalletTypeCreditAmountGrant'
credits_grant:
$ref: '#/components/schemas/WalletTypeCreditCreditsGra
# --- truncated at 32 KB (149 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/solvimon/refs/heads/main/openapi/solvimon-pricingplanschedules-api-openapi.yml