Solvimon pricingPlanSchedules API
The pricingPlanSchedules API from Solvimon — 5 operation(s) for pricingplanschedules.
OpenAPI Specification
openapi: 3.1.0
info:
title: Configuration alertRules pricingPlanSchedules 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:
PricingPlanUpdateRequestAmountType:
type: string
enum:
- EXCLUDING_TAX
- INCLUDING_TAX
description: Set to determine whether the pricings in this pricing plan are including or excluding tax. The default, if left empty, is excluding tax.
title: PricingPlanUpdateRequestAmountType
PricingCurrencySettingsUpdateRequest:
type: object
properties:
default_pricing_currency:
type:
- string
- 'null'
pricing_currencies:
type:
- array
- 'null'
items:
type: string
title: PricingCurrencySettingsUpdateRequest
RateCardUpdateRequest:
type: object
properties:
start_at:
type:
- string
- 'null'
format: date-time
title: RateCardUpdateRequest
AppliedCoupon:
type: object
properties:
id:
type: string
coupon_name:
type:
- string
- 'null'
promotion_code_resource_id:
type:
- string
- 'null'
promotion_code:
type:
- string
- 'null'
discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
title: AppliedCoupon
PricingUpdateRequestProductType:
type: string
enum:
- DEFAULT
- ADDON
title: PricingUpdateRequestProductType
PricingItemConfigPricingType:
type: string
enum:
- FLAT
- FLAT_TOP_UP
- TIERED
- TIERED_TOP_UP
- TOP_TIERED
- STAIR_STEP
- STAIR_STEP_TOP_UP
- FIXED
- PASS_THROUGH
- NONE
title: PricingItemConfigPricingType
ConfiguredMeterValueIncludedVolume:
type: object
properties:
pricing_item_config_id:
type: string
description: Resource ID of type PRICING_ITEM_CONFIG
number:
type:
- string
- 'null'
amount:
$ref: '#/components/schemas/Amount'
start_at:
type:
- string
- 'null'
format: date-time
end_at:
type:
- string
- 'null'
format: date-time
reset_type:
type:
- string
- 'null'
title: ConfiguredMeterValueIncludedVolume
PeriodUpdateRequest:
type: object
properties:
type:
$ref: '#/components/schemas/PeriodUpdateRequestType'
value:
type:
- integer
- 'null'
title: PeriodUpdateRequest
WalletTypeCreditCreditsGrant:
type: object
properties:
credit_type_id:
type: string
description: The credit type for wallets of wallet type.
title: WalletTypeCreditCreditsGrant
PricingPlanVersionSelectorType:
type: string
enum:
- LATEST
- VERSION
description: The type of the selector to determine pricing plan version (by default LATEST).
title: PricingPlanVersionSelectorType
PricingPlanVersionUpdateRequest:
type: object
properties:
object_type:
type:
- string
- 'null'
id:
type:
- string
- 'null'
pricing_plan_id:
type:
- string
- 'null'
description: The resource ID of the pricing plan.
pricing_plan:
oneOf:
- $ref: '#/components/schemas/PricingPlanUpdateRequest'
- type: 'null'
version:
type:
- integer
- 'null'
description: The value describing the version of the pricing plan.
status:
oneOf:
- $ref: '#/components/schemas/PricingPlanVersionUpdateRequestStatus'
- type: 'null'
pricing_currency_settings:
$ref: '#/components/schemas/PricingCurrencySettingsUpdateRequest'
billing_period_settings:
$ref: '#/components/schemas/BillingPeriodSettingsUpdateRequest'
copied_from_pricing_plan_version_id:
type:
- string
- 'null'
description: The id of the pricing plan version from which this pricing plan version was copied
pricing_categories:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/PricingCategoryUpdateRequest'
description: The list of priced categories that are within the pricing plan.
credit_types:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/CreditTypeUpdateRequest'
rate_card:
$ref: '#/components/schemas/RateCardUpdateRequest'
title: PricingPlanVersionUpdateRequest
MeterPropertyConditionComparator:
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: MeterPropertyConditionComparator
LinkedIntegration:
type: object
properties:
id:
type: string
link_details:
type: array
items:
$ref: '#/components/schemas/LinkDetail'
title: LinkedIntegration
IntegrationDetails:
type: object
properties:
id:
type:
- string
- 'null'
reference:
type:
- string
- 'null'
payment_gateway_variant:
$ref: '#/components/schemas/IntegrationDetailsPaymentGatewayVariant'
adyen:
$ref: '#/components/schemas/AdyenIntegrationDetails'
stripe:
$ref: '#/components/schemas/StripeIntegrationDetails'
title: IntegrationDetails
WalletTypeCreditAmountGrantTaxCategory:
type: string
enum:
- STANDARD
- NO_TAX
- EXEMPT
description: The tax category to for what the wallet can be applied to.
title: WalletTypeCreditAmountGrantTaxCategory
PricingUpdateRequestOriginalPricing:
type: object
properties: {}
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.
title: PricingUpdateRequestOriginalPricing
PricingPlanScheduleCreateRequestType:
type: string
enum:
- TRIAL
- DEFAULT
description: The type of the pricing plan schedule.
title: PricingPlanScheduleCreateRequestType
MeterStatus:
type: string
enum:
- DRAFT
- ACTIVE
- ARCHIVED
- DEPRECATED
description: The status of the meter indicating the activity of the meter and the ability to update properties.
title: MeterStatus
PricingItemConfigWalletGrant:
type: object
properties:
wallet_type_id:
type: string
description: Resource ID of type WALLET_TYPE
wallet_type:
oneOf:
- $ref: '#/components/schemas/WalletType'
- type: 'null'
amount_grant:
$ref: '#/components/schemas/PricingItemConfigWalletGrantAmountGrant'
credits_grant:
$ref: '#/components/schemas/PricingItemConfigWalletGrantCreditsGrant'
expiry_policy:
$ref: '#/components/schemas/PricingItemConfigWalletGrantExpiryPolicy'
title: PricingItemConfigWalletGrant
PricingItemBillingPeriodConfig:
type: object
properties:
billing_period:
$ref: '#/components/schemas/Period'
configs:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/PricingItemConfig'
title: PricingItemBillingPeriodConfig
PricingPlanVersionSelector:
type: object
properties:
pricing_plan_id:
type:
- string
- 'null'
description: The ID of the pricing plan.
pricing_plan_reference:
type:
- string
- 'null'
description: Or the reference of the pricing plan.
type:
oneOf:
- $ref: '#/components/schemas/PricingPlanVersionSelectorType'
- type: 'null'
description: The type of the selector to determine pricing plan version (by default LATEST).
version:
type:
- integer
- 'null'
description: The specific version of the pricing plan version, in case of type VERSION
title: PricingPlanVersionSelector
PricingPlanSchedule:
type: object
properties:
object_type:
type:
- string
- 'null'
id:
type:
- string
- 'null'
type:
oneOf:
- $ref: '#/components/schemas/PricingPlanScheduleType'
- 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/PricingPlanVersionSelector'
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/PricingPlanSchedulePricingCurrency'
- type: 'null'
description: The default alphabetic currency code representing the type of currency used for the pricing.
billing_period:
$ref: '#/components/schemas/Period'
entitlements:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Entitlement'
discount:
$ref: '#/components/schemas/Discount'
markup:
$ref: '#/components/schemas/Markup'
commitment:
$ref: '#/components/schemas/Commitment'
promotion_codes:
type:
- array
- 'null'
items:
type: string
coupon_ids:
type:
- array
- 'null'
items:
type: string
coupon_discount:
oneOf:
- $ref: '#/components/schemas/Discount'
- type: 'null'
coupons:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/AppliedCoupon'
seats_values:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ConfiguredMeterValue'
included_volumes:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ConfiguredMeterValueIncludedVolume'
enabled_pricings:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/EnabledPricing'
override_pricings:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Pricing'
pricing_categories:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/PricingCategory'
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/PricingPlanVersion'
- type: 'null'
realign_invoice_date_to_pricing_plan_schedule_start_at:
type:
- boolean
- 'null'
created_at:
type:
- string
- 'null'
title: PricingPlanSchedule
ProductStatus:
type: string
enum:
- DRAFT
- ACTIVE
- ARCHIVED
- DEPRECATED
description: The status of the product.
title: ProductStatus
WalletTypeStatus:
type: string
enum:
- DRAFT
- ACTIVE
- INACTIVE
- DEPRECATED
- ARCHIVED
title: WalletTypeStatus
PricingItemConfigConditionsConfigsItems:
type: object
properties: {}
title: PricingItemConfigConditionsConfigsItems
ProductItemModelType:
type: string
enum:
- USAGE_BASED
- USAGE_BASED_CONVERSION
- RECURRING
- ONE_OFF
- PER_SEAT
- CREDITS
title: ProductItemModelType
PricingItemConfigWalletGrantCre
# --- 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