Solvimon pricingPlanSubscriptions API
The pricingPlanSubscriptions API from Solvimon — 9 operation(s) for pricingplansubscriptions.
The pricingPlanSubscriptions API from Solvimon — 9 operation(s) for pricingplansubscriptions.
openapi: 3.1.0
info:
title: Configuration alertRules pricingPlanSubscriptions 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: pricingPlanSubscriptions
paths:
/v{version}/pricing-plan-subscriptions:
get:
operationId: getPricingPlanSubscriptions
summary: Get a list of pricing plan subscriptions
description: Requires the PRICING_PLAN_SUBSCRIPTION.VIEW or QUOTE.PRICING_PLAN_SUBSCRIPTION.VIEW permission.
tags:
- pricingPlanSubscriptions
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: customer_id
in: query
description: The resource id of the customer.
required: false
schema:
type: string
- name: pricing_plan_subscription_group_id
in: query
description: The resource id of the pricing plan subscription group.
required: false
schema:
type: string
- name: reference
in: query
description: The reference by which the resource will be filtered. To use this filter, the customer_id must also be present.
required: false
schema:
type: string
- name: type
in: query
description: The type of the pricing plan subscription.
required: false
schema:
type: string
- name: variant
in: query
description: The variant of the pricing plan subscription.
required: false
schema:
type: string
- name: status
in: query
description: The status of the pricing plan subscription.
required: false
schema:
type: string
- name: statuses[]
in: query
description: The status(es) of the pricing plan subscription.
required: false
schema:
type: array
items:
type: string
- name: custom_field
in: query
description: Filter the response by a custom field value.
required: false
schema:
type: string
- name: start_at
in: query
description: Range filter for the start_at of the first schedule in the pricing plan subscription (ISO-8601).
required: false
schema:
type: string
- name: created_at
in: query
description: Range filter for the created_at in the pricing plan subscription (ISO-8601).
required: false
schema:
type: string
- name: page
in: query
description: The page which is going to be shown
required: false
schema:
type: integer
- name: limit
in: query
description: The amount of records shown in the list
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/PricingPlanSubscriptionResponseWrapper'
'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: postPricingPlanSubscriptions
summary: Create a pricing plan subscription
description: Requires the PRICING_PLAN_SUBSCRIPTION.CREATE or QUOTE.PRICING_PLAN_SUBSCRIPTION.CREATE permission.
tags:
- pricingPlanSubscriptions
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/PricingPlanSubscription'
'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/PricingPlanSubscriptionCreateRequest'
put:
operationId: putPricingPlanSubscriptions
summary: Update or create a pricing plan subscription (upsert)
description: Requires the PRICING_PLAN_SUBSCRIPTION.CREATE, QUOTE.PRICING_PLAN_SUBSCRIPTION.CREATE, PRICING_PLAN_SUBSCRIPTION.UPDATE or QUOTE.PRICING_PLAN_SUBSCRIPTION.UPDATE permission.
tags:
- pricingPlanSubscriptions
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: identifier_field
in: query
description: Which field to use to identify whether the resource exists or not
required: false
schema:
type: string
- name: custom_field_reference
in: query
description: Which custom field to use to identify whether the resource exists or not
required: false
schema:
type: string
- name: field_actions
in: query
description: The list of actions for specific fields.
required: false
schema:
type: object
additionalProperties:
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:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/PricingPlanSubscription'
'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'
'404':
description: Not Found
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/PricingPlanSubscriptionCreateRequest'
/v{version}/pricing-plan-subscriptions/init:
post:
operationId: postPricingPlanSubscriptionsInit
summary: Create a pricing plan subscription and schedule. This will also result in a first invoice being created for the provided pricing plan schedule and subscription.
description: Requires the PRICING_PLAN_SUBSCRIPTION.CREATE permission.
tags:
- pricingPlanSubscriptions
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:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PricingPlanSubscriptionInit'
'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/PricingPlanSubscriptionInitCreateRequest'
/v{version}/pricing-plan-subscriptions/search:
post:
operationId: postPricingPlanSubscriptionsSearch
summary: Search a pricing plan subscription
description: Requires the PRICING_PLAN_SUBSCRIPTION.VIEW permission.
tags:
- pricingPlanSubscriptions
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/PricingPlanSubscriptionResponseWrapper'
'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-plan-subscriptions/{resourceId}:
get:
operationId: getPricingPlanSubscriptionsByResourceId
summary: Get a pricing plan subscription by its ID
description: Requires the PRICING_PLAN_SUBSCRIPTION.VIEW or QUOTE.PRICING_PLAN_SUBSCRIPTION.VIEW permission.
tags:
- pricingPlanSubscriptions
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: 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/PricingPlanSubscription'
'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: deletePricingPlanSubscriptionsByResourceId
summary: Delete a pricing plan subscription by resource ID
description: Requires the PRICING_PLAN_SUBSCRIPTION.DELETE permission.
tags:
- pricingPlanSubscriptions
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/PricingPlanSubscription'
'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'
patch:
operationId: patchPricingPlanSubscriptionsByResourceId
summary: Update a pricing plan subscription by resource ID
description: Requires the PRICING_PLAN_SUBSCRIPTION.UPDATE or QUOTE.PRICING_PLAN_SUBSCRIPTION.UPDATE permission.
tags:
- pricingPlanSubscriptions
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/PricingPlanSubscription'
'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/PricingPlanSubscriptionUpdateRequest'
/v{version}/pricing-plan-subscriptions/{resourceId}/void:
post:
operationId: postPricingPlanSubscriptionsByResourceIdVoid
summary: Void a pricing plan subscription by resource ID
description: Requires the PRICING_PLAN_SUBSCRIPTION.STATUS.UPDATE permission.
tags:
- pricingPlanSubscriptions
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceId
in: path
description: The ID of the resource for which the action is posted.
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/PricingPlanSubscription'
'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-subscriptions/{resourceId}/archive:
post:
operationId: postPricingPlanSubscriptionsByResourceIdArchive
summary: Archive a pricing plan subscription by resource ID
description: Requires the PRICING_PLAN_SUBSCRIPTION.STATUS.UPDATE permission.
tags:
- pricingPlanSubscriptions
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceId
in: path
description: The ID of the resource for which the action is posted.
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/PricingPlanSubscription'
'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-subscriptions/{resourceId}/cancel:
post:
operationId: postPricingPlanSubscriptionsByResourceIdCancel
summary: Cancel a pricing plan subscription by resource ID
description: Requires the PRICING_PLAN_SUBSCRIPTION.CANCEL permission.
tags:
- pricingPlanSubscriptions
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceId
in: path
description: The ID of the resource for which the action is posted.
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/PricingPlanSubscription'
'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/PricingPlanSubscriptionCancelCreateRequest'
/v{version}/pricing-plan-subscriptions/{resourceId}/copy:
post:
operationId: postPricingPlanSubscriptionsByResourceIdCopy
summary: Copy a pricing plan subscription by resource ID
description: Requires the PRICING_PLAN_SUBSCRIPTION.CREATE permission.
tags:
- pricingPlanSubscriptions
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceId
in: path
description: The ID of the resource for which the action is posted.
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/PricingPlanSubscription'
'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/PricingPlanSubscriptionCopyCreateRequest'
/v{version}/pricing-plan-subscriptions/{resourceId}/update-payment-method:
post:
operationId: postPricingPlanSubscriptionsByResourceIdUpdatePaymentMethod
summary: Change the payment method of a pricing plan subscription
description: Requires the PRICING_PLAN_SUBSCRIPTION.UPDATE permission.
tags:
- pricingPlanSubscriptions
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceId
in: path
description: The ID of the resource for which the action is posted.
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/PricingPlanSubscription'
'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/PricingPlanSubscriptionPaymentMethodUpdateCreateRequest'
components:
schemas:
EInvoicingMapping:
type: object
properties:
target:
type: string
description: The target field for a UBL Invoice
source:
type:
- string
- 'null'
description: The source field from a Solvimon Invoice
description:
type:
- string
- 'null'
description: Optional description for the mapping
title: EInvoicingMapping
ChargeOnDemandPaymentContext:
type: object
properties:
pricing_plan_schedule_id:
type: string
description: Resource ID of type PRICING_PLAN_SCHEDULE
pricing_items:
type: array
items:
$ref: '#/components/schemas/ChargeOnDemandPaymentContextPricingItem'
start_at:
type:
- string
- 'null'
format: date-time
title: ChargeOnDemandPaymentContext
CreatePaymentMethodPaymentContext:
type: object
properties:
payment_method_id:
type: string
description: Resource ID of type PAYMENT_METHOD
title: CreatePaymentMethodPaymentContext
PricingPlanVersionSelectorType:
type: string
enum:
- LATEST
- VERSION
description: The type of the selector to determine pricing plan version (by default LATEST).
title: PricingPlanVersionSelectorType
InvoiceCreateRequestApprovalStatus:
type: string
enum:
- PENDING_REVIEW
- APPROVED
- DECLINED
- CANCELLED
description: Approval status for invoices that are associated with an approval request
title: InvoiceCreateRequestApprovalStatus
InvoiceCreditDetailCreditDetailsSource:
type: string
enum:
- CURRENT
- ORIGINAL
description: Source of customer and billing entity information on credit invoices, CURRENT by default.
title: InvoiceCreditDetailCreditDetailsSource
WalletTypeCreditAmountGrantTaxCategory:
type: string
enum:
- STANDARD
- NO_TAX
- EXEMPT
description: The tax category to for what the wallet can be applied to.
title: WalletTypeCreditAmountGrantTaxCategory
PricingPlanScheduleCreateRequestType:
type: string
enum:
- TRIAL
- DEFAULT
description: The type of the pricing plan schedule.
title: PricingPlanScheduleCreateRequestType
PaymentCreateRequestResult:
type: string
enum:
- AUTHORIZED
- CANCELLED
- CHARGED_BACK
- ERROR
- PENDING
- REFUSED
- REFUNDED
title: PaymentCreateRequestResult
EInvoiceFileFormat:
type: object
properties:
type:
type:
- string
- 'null'
description: The format of the eInvoice that can be downloaded
desc
# --- truncated at 32 KB (319 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/solvimon/refs/heads/main/openapi/solvimon-pricingplansubscriptions-api-openapi.yml