Get a pricingPlanSchedule by resourceID

GET

/v:version/pricing-plan-schedules/:resourceId

GET

/v:version/pricing-plan-schedules/:resourceId

curl https://test.api.solvimon.com/v1/pricing-plan-schedules/ \
     -H "X-API-KEY: <apiKey>"

{
  "object_type": "PRICING_PLAN_SCHEDULE",
  "id": "ppsc_VwDeeN0vxxHyUeCYqx16",
  "type": "DEFAULT",
  "status": "ACTIVE",
  "pricing_plan_subscription_id": "ppsu_dwDeeN0vxxHy6VCoVC1b",
  "pricing_plan_id": "ppla_kwDeeN0vxxHy5fCeDy1e",
  "pricing_plan_version_id": "ppve_YwDeeN0vxxHy6aCOdT1C",
  "start_at": "2026-09-01T07:00:00Z",
  "end_at": "2027-09-01T07:00:00Z",
  "pricing_currency": "USD",
  "combined_pricing_plan_version": {
    "object_type": "PRICING_PLAN_VERSION",
    "id": "ppve_YwDeeN0vxxHy6aCOdT1C",
    "pricing_plan_id": "ppla_kwDeeN0vxxHy5fCeDy1e",
    "version": 1,
    "status": "ACTIVE",
    "pricing_categories": [
      {
        "object_type": "PRICING_CATEGORY",
        "product_category_id": "proc_YwDeeN0vxxHxVbCEik1P",
        "pricings": [
          {
            "object_type": "PRICING",
            "id": "pric_awDeeN0vxxHy97C1vt1Q",
            "pricing_plan_version_id": "ppve_YwDeeN0vxxHy6aCOdT1C",
            "name": "Enterprise platform",
            "product_type": "DEFAULT",
            "product_ids": [
              "prod_fwDeeN0vxxHxTMCoh019"
            ],
            "items": [
              {
                "object_type": "PRICING_ITEM",
                "id": "prii_SwDeeN0vxxHy0tCe6n12",
                "product_item_ids": [
                  "proi_rwDeeN0vxxHxUICfhY1O"
                ],
                "configs": [
                  {
                    "object_type": "PRICING_ITEM_CONFIG",
                    "id": "pico_dwDeeN0vxxHyOdCQ9V1W",
                    "details": {
                      "pricing_type": "FLAT",
                      "bands": [
                        {
                          "amount": {
                            "quantity": "2000.00",
                            "currency": "USD"
                          }
                        }
                      ]
                    },
                    "order": 1,
                    "billing_in_advance": true
                  }
                ]
              }
            ]
          }
        ],
        "display_order": 1
      }
    ]
  },
  "created_at": "2026-08-27T16:20:41Z",
  "updated_at": "2026-08-27T16:22:03Z",
  "is_current": true
}

Requires the QUOTE.PRICING_PLAN_SCHEDULE.VIEW or PRICING_PLAN_SCHEDULE.VIEW permission. Which one depends on the type of the subscription: QUOTE requires QUOTE.PRICING_PLAN_SCHEDULE.VIEW; BILLING and TEMPLATE require PRICING_PLAN_SCHEDULE.VIEW.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

resourceIdstringRequiredDefaults to

The ID of the resource to be requested.

Query parameters

expand[]list of stringsOptional

The id fields of the resources that are going to be expanded.

include_combined_pricing_plan_versionbooleanOptional

Get the pricing plan version with the pricing overrides.

Response

object_typestring or nullOptionalRead-only

idstring or nullOptionalRead-only

typeenum or nullOptional

The type of the pricing plan schedule.

Allowed values:

statusenum or nullOptional

The status of the pricing plan schedule. Defaults to ACTIVE.

Allowed values:

approval_statusenum or nullOptionalRead-only

Approval status for schedules that are associated with an approval request

Allowed values:

pricing_plan_subscription_idstringOptional

Resource ID of type PRICING_PLAN_SUBSCRIPTION

pricing_plan_idstring or nullOptional

The resource ID of the pricing plan.

pricing_plan_version_idstring or nullOptional

The resource ID of the pricing plan version.

pricing_plan_version_selectorobjectOptional

Instead of the pricing_plan_version_id, during creation, a selector can be submitted to determine the pricing plan version.

start_atdatetimeOptional

end_atdatetime or nullOptional

pricing_currencyenum or nullOptional

The default alphabetic currency code representing the type of currency used for the pricing.

billing_periodobjectOptional

entitlementslist of objects or nullOptional

discountobjectOptional

markupobjectOptional

commitmentobjectOptional

coupon_discountobject or nullOptional

couponslist of objects or nullOptional

seats_valueslist of objects or nullOptional

unitslist of objects or nullOptional

The number of units billed per One Off pricing item config priced FLAT. Overrides default_units; absent falls back to it, then to 1.

included_volumeslist of objects or nullOptional

enabled_pricingslist of objects or nullOptional

override_pricingslist of objects or nullOptional

pricing_categorieslist of objects or nullOptional

Pricing defined directly on this schedule, in addition to (or instead of) a linked pricing plan version / rate-card.

combined_pricing_plan_versionobject or nullOptional

realign_invoice_date_to_pricing_plan_schedule_start_atboolean or nullOptional

created_atstring or nullOptionalRead-only

updated_atstring or nullOptionalRead-only

is_currentboolean or nullOptionalRead-only

Whether this schedule is currently in effect, based on its start_at/end_at and ACTIVE status.

promotion_codeslist of strings or nullOptionalDeprecated

coupon_idslist of strings or nullOptionalDeprecated

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors