Solvimon pricingPlans API
The pricingPlans API from Solvimon — 3 operation(s) for pricingplans.
OpenAPI Specification
openapi: 3.1.0
info:
title: Configuration alertRules pricingPlans 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: pricingPlans
paths:
/v{version}/pricing-plans:
get:
operationId: getPricingPlans
summary: Get a list of all pricing plans
description: Requires the PRICING_PLAN.VIEW permission.
tags:
- pricingPlans
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: type
in: query
description: The type of the pricing plan to filter on.
required: false
schema:
type: string
- name: customer_id
in: query
description: The customer resource ID to filter on.
required: false
schema:
type: string
- name: statuses[]
in: query
description: Filter pricing plans based on pricing plan version status(es)
required: false
schema:
type: array
items:
type: string
- name: variants[]
in: query
description: Filter pricing plans based on pricing plan variant
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/PricingPlanResponseWrapper'
'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: postPricingPlans
summary: Create a pricing plan
description: Requires the PRICING_PLAN.CREATE permission.
tags:
- pricingPlans
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/PricingPlan'
'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/PricingPlanCreateRequest'
put:
operationId: putPricingPlans
summary: Update or create a pricing plan (upsert)
description: Requires the PRICING_PLAN.CREATE or PRICING_PLAN.UPDATE permission.
tags:
- pricingPlans
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/PricingPlan'
'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/PricingPlanCreateRequest'
/v{version}/pricing-plans/search:
post:
operationId: postPricingPlansSearch
summary: search a pricing plan
description: Requires the PRICING_PLAN.VIEW permission.
tags:
- pricingPlans
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: 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. default = name
required: false
schema:
type: string
- name: order_direction
in: query
description: The parameter for the response ordering direction (asc, desc) default asc
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/PricingPlanResponseWrapper'
'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/SearchCreateRequest'
/v{version}/pricing-plans/{resourceIdOrReference}:
get:
operationId: getPricingPlansByResourceIdOrReference
summary: Get a pricing plan
description: Requires the PRICING_PLAN.VIEW permission.
tags:
- pricingPlans
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/PricingPlan'
'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: deletePricingPlansByResourceIdOrReference
summary: Delete a pricing plan
description: Requires the PRICING_PLAN.DELETE permission.
tags:
- pricingPlans
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/PricingPlan'
'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: patchPricingPlansByResourceIdOrReference
summary: Update a pricing plan
description: Requires the PRICING_PLAN.UPDATE permission.
tags:
- pricingPlans
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/PricingPlan'
'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/PricingPlanUpdateRequest'
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
PricingPlanUpdateRequestVariant:
type: string
enum:
- DEFAULT
- RATE_CARD
title: PricingPlanUpdateRequestVariant
PricingPlanPricingCurrenciesItems:
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 that can be used for the pricings.
title: PricingPlanPricingCurrenciesItems
CustomFieldValue:
type: object
properties:
id:
type:
- string
- 'null'
description: Resource ID of type CUSTOM_FIELD
reference:
type:
- string
- 'null'
value:
type:
- string
- 'null'
values:
type:
- array
- 'null'
items:
type: string
integration_details:
oneOf:
- $ref: '#/components/schemas/IntegrationDetails'
- type: 'null'
integration_id:
type: string
description: The resource ID of the integration linked to the custom field
title: CustomFieldValue
SearchCreateRequest:
type: object
properties:
search_fields:
type: array
items:
$ref: '#/components/schemas/SearchFieldCreateRequest'
filter_fields:
type: array
items:
$ref: '#/components/schemas/FilterFieldCreateRequest'
selection_rule_fields:
type: array
items:
$ref: '#/components/schemas/SelectionRuleFieldCreateRequest'
title: SearchCreateRequest
PricingPlanCreateRequestAmountType:
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: PricingPlanCreateRequestAmountType
SelectionRuleType:
type: string
enum:
- RESOURCE
title: SelectionRuleType
PricingPlanCreateRequestType:
type: string
enum:
- STANDARD
- CUSTOM
title: PricingPlanCreateRequestType
SelectionRuleResource:
type: object
properties:
type:
$ref: '#/components/schemas/SelectionRuleResourceType'
field:
$ref: '#/components/schemas/SelectionRuleResourceField'
value:
type:
- string
- 'null'
values:
type:
- array
- 'null'
items:
type: string
comparator:
$ref: '#/components/schemas/SelectionRuleResourceComparator'
title: SelectionRuleResource
PricingPlanCreateRequestPricingCurrenciesItems:
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 that can be used for the pricings.
title: PricingPlanCreateRequestPricingCurrenciesItems
PricingPlanVersionInfoCreateRequest:
type: object
properties:
version:
type: integer
id:
type: string
status:
type: string
rate_card:
$ref: '#/components/schemas/RateCard'
title: PricingPlanVersionInfoCreateRequest
FilterFieldCreateRequest:
type: object
properties:
name:
type: string
reference:
type:
- string
- 'null'
value:
type:
- string
- 'null'
values:
type: array
items:
type: string
title: FilterFieldCreateRequest
PricingPlanVersionInfoUpdateRequest:
type: object
properties:
version:
type: integer
id:
type: string
status:
type: string
rate_card:
$ref: '#/components/schemas/RateCard'
title: PricingPlanVersionInfoUpdateRequest
RateCard:
type: object
properties:
start_at:
type:
- string
- 'null'
format: date-time
title: RateCard
SelectionRuleCreateRequest:
type: object
properties:
type:
$ref: '#/components/schemas/SelectionRuleCreateRequestType'
resource:
$ref: '#/components/schemas/SelectionRuleResource'
title: SelectionRuleCreateRequest
PricingPlanCreateRequestVariant:
type: string
enum:
- DEFAULT
- RATE_CARD
title: PricingPlanCreateRequestVariant
SelectionRule:
type: object
properties:
type:
$ref: '#/components/schemas/SelectionRuleType'
resource:
$ref: '#/components/schemas/SelectionRuleResource'
title: SelectionRule
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
SelectionRuleResourceField:
type: string
enum:
- COUNTRY
title: SelectionRuleResourceField
SelectionRuleCreateRequestType:
type: string
enum:
- RESOURCE
title: SelectionRuleCreateRequestType
PricingPlanVersionInfo:
type: object
properties:
version:
type: integer
id:
type: string
status:
type: string
rate_card:
$ref: '#/components/schemas/RateCard'
title: PricingPlanVersionInfo
PricingPlanUpdateRequest:
type: object
properties:
object_type:
type:
- string
- 'null'
id:
type:
- string
- 'null'
reference:
type: string
name:
type:
- string
- 'null'
description:
type:
- string
- 'null'
customer_id:
type:
- string
- 'null'
description: Resource ID of type CUSTOMER
type:
oneOf:
- $ref: '#/components/schemas/PricingPlanUpdateRequestType'
- type: 'null'
amount_type:
$ref: '#/components/schemas/PricingPlanUpdateRequestAmountType'
description: Set to determine whether the pricings in this pricing plan are including or excluding tax. The default, if left empty, is excluding tax.
pricing_plan_version_infos:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/PricingPlanVersionInfoUpdateRequest'
pricing_plan_selection_rules:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/SelectionRuleUpdateRequest'
pricing_currencies:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/PricingPlanUpdateRequestPricingCurrenciesItems'
description: The default alphabetic currency code representing the type of currency that can be used for the pricings.
variant:
oneOf:
- $ref: '#/components/schemas/PricingPlanUpdateRequestVariant'
- type: 'null'
custom_fields:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/CustomFieldValueUpdateRequest'
description: Custom fields associated to this pricing plan
title: PricingPlanUpdateRequest
PricingPlanType:
type: string
enum:
- STANDARD
- CUSTOM
title: PricingPlanType
StripeIntegrationDetails:
type: object
properties:
payment_method_id:
type: string
title: StripeIntegrationDetails
PricingPlanCreateRequest:
type: object
properties:
object_type:
type:
- string
- 'null'
id:
type:
- string
- 'null'
reference:
type: string
name:
type:
- string
- 'null'
description:
type:
- string
- 'null'
customer_id:
type:
- string
- 'null'
description: Resource ID of type CUSTOMER
type:
oneOf:
- $ref: '#/components/schemas/PricingPlanCreateRequestType'
- type: 'null'
amount_type:
$ref: '#/components/schemas/PricingPlanCreateRequestAmountType'
description: Set to determine whether the pricings in this pricing plan are including or excluding tax. The default, if left empty, is excluding tax.
pricing_plan_version_infos:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/PricingPlanVersionInfoCreateRequest'
pricing_plan_selection_rules:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/SelectionRuleCreateRequest'
pricing_currencies:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/PricingPlanCreateRequestPricingCurrenciesItems'
description: The default alphabetic currency code representing the type of currency that can be used for the pricings.
variant:
oneOf:
- $ref: '#/components/schemas/PricingPlanCreateRequestVariant'
- type: 'null'
custom_fields:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/CustomFieldValueCreateRequest'
description: Custom fields associated to this pricing plan
required:
- reference
title: PricingPlanCreateRequest
PricingPlanUpdateRequestType:
type: string
enum:
- STANDARD
- CUSTOM
title: PricingPlanUpdateRequestType
IntegrationDetailsPaymentGatewayVariant:
type: string
enum:
- ADYEN
- STRIPE
title: IntegrationDetailsPaymentGatewayVariant
CustomFieldValueCreateRequest:
type: object
properties:
id:
type:
- string
- 'null'
description: Resource ID of type CUSTOM_FIELD
reference:
type:
- string
- 'null'
value:
type:
- string
- 'null'
values:
type:
- array
- 'null'
items:
type: string
integration_details:
oneOf:
- $ref: '#/components/schemas/IntegrationDetails'
- type: 'null'
integration_id:
type: string
description: The resource ID of the integration linked to the custom field
title: CustomFieldValueCreateRequest
SelectionRuleUpdateRequestType:
type: string
enum:
- RESOURCE
title: SelectionRuleUpdateRequestType
PricingPlanAmountType:
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: PricingPlanAmountType
SelectionRuleUpdateRequest:
type: object
properties:
type:
$ref: '#/components/schemas/SelectionRuleUpdateRequestType'
resource:
$ref: '#/components/schemas/SelectionRuleResource'
title: SelectionRuleUpdateRequest
ApiErrorType:
type: string
enum:
- API_ERROR
- INVALID_REQUEST
title: ApiErrorType
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
SelectionRuleFieldCreateRequest:
type: object
properties:
name:
type: string
value:
type:
- string
- 'null'
title: SelectionRuleFieldCreateRequest
PricingPlanVariant:
type: string
enum:
- DEFAULT
- RATE_CARD
title: PricingPlanVariant
CustomFieldValueUpdateRequest:
type: object
properties:
id:
type:
- string
- 'null'
description: Resource ID of type CUSTOM_FIELD
reference:
type:
- string
- 'null'
value:
type:
- string
# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/solvimon/refs/heads/main/openapi/solvimon-pricingplans-api-openapi.yml