Get a pricingPlanSchedule by resourceID

GET

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

GET

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

1 curl https://test.api.solvimon.com/v1/pricing-plan-schedules/ \
2      -H "X-API-KEY: <apiKey>" \
3      -H "Content-Type: application/json"

1 {
2   "pricing_plan_subscription_id": "sub_9876543210abcdef",
3   "start_at": "2024-01-15T09:30:00Z",
4   "object_type": "pricing_plan_schedule",
5   "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
6   "type": "TRIAL",
7   "pricing_plan_id": "plan_1234567890abcdef",
8   "pricing_plan_version_id": "ver_2024_04_01",
9   "end_at": "2024-02-15T09:30:00Z",
10   "pricing_currency": "AED",
11   "billing_period": {
12     "type": "DAY",
13     "value": 30
14   },
15   "entitlements": [
16     {
17       "feature_id": "feat_001",
18       "feature": {
19         "reference": "premium_support",
20         "object_type": "feature",
21         "id": "feat_001",
22         "name": "Premium Support",
23         "description": "Access to 24/7 premium customer support",
24         "type": "SWITCH",
25         "enum_values": [
26           "ENABLED",
27           "DISABLED"
28         ],
29         "meter_value_calculation_id": "calc_001",
30         "meter_value_calculation": {
31           "reference": "total_usage",
32           "object_type": "meter_value_calculation",
33           "id": "calc_001",
34           "name": "Total Usage Calculation",
35           "description": "Sum of all usage metrics",
36           "calculation_type": "SUM",
37           "persist": true,
38           "meter_id": "meter_001",
39           "meter": {
40             "reference": "api_calls",
41             "object_type": "meter",
42             "id": "meter_001",
43             "name": "API Calls Meter",
44             "description": "Tracks number of API calls",
45             "status": "ACTIVE",
46             "meter_values": [
47               {
48                 "id": "mv_001",
49                 "object": {
50                   "reference": "daily_api_calls",
51                   "object_type": "meter_value",
52                   "id": "mv_001",
53                   "name": "Daily API Calls",
54                   "description": "Number of API calls per day",
55                   "status": "ACTIVE",
56                   "type": "NUMBER"
57                 },
58                 "required": true
59               }
60             ],
61             "meter_properties": [
62               {
63                 "id": "mp_001",
64                 "object": {
65                   "reference": "region",
66                   "status": "ACTIVE",
67                   "object_type": "meter_property",
68                   "id": "mp_001",
69                   "name": "Region",
70                   "description": "Geographical region of usage",
71                   "type": "STRING",
72                   "enum_values": [
73                     "EMEA",
74                     "APAC",
75                     "AMER"
76                   ]
77                 },
78                 "required": true
79               }
80             ]
81           },
82           "meter_value_id": "mv_001",
83           "meter_value": {
84             "reference": "daily_api_calls",
85             "object_type": "meter_value",
86             "id": "mv_001",
87             "name": "Daily API Calls",
88             "description": "Number of API calls per day",
89             "status": "ACTIVE",
90             "type": "NUMBER"
91           },
92           "meter_property_id": "mp_001",
93           "meter_property": {
94             "reference": "region",
95             "status": "ACTIVE",
96             "object_type": "meter_property",
97             "id": "mp_001",
98             "name": "Region",
99             "description": "Geographical region of usage",
100             "type": "STRING",
101             "enum_values": [
102               "EMEA",
103               "APAC",
104               "AMER"
105             ]
106           }
107         }
108       },
109       "feature_reference": "premium_support",
110       "override": true,
111       "number": "1",
112       "switch": true,
113       "amount": {
114         "quantity": "0",
115         "currency": "AED"
116       },
117       "enum": "ENABLED",
118       "string": "Enabled",
119       "overwrite": true
120     }
121   ],
122   "discount": {
123     "pricing_item_configs": [
124       {
125         "ids": [
126           "pic_001"
127         ],
128         "start_at": "2024-01-15T09:30:00Z",
129         "end_at": "2024-02-15T09:30:00Z",
130         "amount": {
131           "quantity": "50.00",
132           "currency": "AED"
133         },
134         "percentage": "10"
135       }
136     ],
137     "pricing_items": [
138       {
139         "ids": [
140           "pi_001"
141         ],
142         "start_at": "2024-01-15T09:30:00Z",
143         "end_at": "2024-02-15T09:30:00Z",
144         "amount": {
145           "quantity": "25.00",
146           "currency": "AED"
147         },
148         "percentage": "5"
149       }
150     ],
151     "pricings": [
152       {
153         "ids": [
154           "pricing_001"
155         ],
156         "start_at": "2024-01-15T09:30:00Z",
157         "end_at": "2024-02-15T09:30:00Z",
158         "amount": {
159           "quantity": "75.00",
160           "currency": "AED"
161         },
162         "percentage": "15"
163       }
164     ],
165     "totals": [
166       {
167         "start_at": "2024-01-15T09:30:00Z",
168         "end_at": "2024-02-15T09:30:00Z",
169         "amount": {
170           "quantity": "150.00",
171           "currency": "AED"
172         },
173         "percentage": "20",
174         "coupon_id": "coupon_12345",
175         "promotion_code_details": {
176           "promotion_code_id": "promo_abc123",
177           "code": "NEWYEAR2024"
178         }
179       }
180     ],
181     "products": [
182       {
183         "ids": [
184           "prod_001"
185         ],
186         "start_at": "2024-01-15T09:30:00Z",
187         "end_at": "2024-02-15T09:30:00Z",
188         "amount": {
189           "quantity": "30.00",
190           "currency": "AED"
191         },
192         "percentage": "7",
193         "coupon_id": "coupon_12345",
194         "promotion_code_details": {
195           "promotion_code_id": "promo_abc123",
196           "code": "NEWYEAR2024"
197         }
198       }
199     ],
200     "product_items": [
201       {
202         "ids": [
203           "prod_item_001"
204         ],
205         "start_at": "2024-01-15T09:30:00Z",
206         "end_at": "2024-02-15T09:30:00Z",
207         "amount": {
208           "quantity": "15.00",
209           "currency": "AED"
210         },
211         "percentage": "3",
212         "coupon_id": "coupon_12345",
213         "promotion_code_details": {
214           "promotion_code_id": "promo_abc123",
215           "code": "NEWYEAR2024"
216         }
217       }
218     ],
219     "product_categories": [
220       {
221         "ids": [
222           "cat_001"
223         ],
224         "start_at": "2024-01-15T09:30:00Z",
225         "end_at": "2024-02-15T09:30:00Z",
226         "amount": {
227           "quantity": "20.00",
228           "currency": "AED"
229         },
230         "percentage": "4",
231         "coupon_id": "coupon_12345",
232         "promotion_code_details": {
233           "promotion_code_id": "promo_abc123",
234           "code": "NEWYEAR2024"
235         }
236       }
237     ]
238   },
239   "markup": {
240     "pricing_item_configs": [
241       {
242         "ids": [
243           "pic_002"
244         ],
245         "start_at": "2024-01-15T09:30:00Z",
246         "end_at": "2024-02-15T09:30:00Z",
247         "amount": {
248           "quantity": "10.00",
249           "currency": "AED"
250         },
251         "percentage": "5"
252       }
253     ]
254   },
255   "commitment": {
256     "pricing_item_configs": [
257       {
258         "ids": [
259           "pic_003"
260         ],
261         "meter_value_calculation": {
262           "number": "1000",
263           "amount": {
264             "quantity": "500.00",
265             "currency": "AED"
266           }
267         },
268         "start_at": "2024-01-15T09:30:00Z",
269         "end_at": "2024-12-31T23:59:59Z",
270         "amount": {
271           "quantity": "500.00",
272           "currency": "AED"
273         }
274       }
275     ],
276     "pricing_items": [
277       {
278         "ids": [
279           "pi_002"
280         ],
281         "start_at": "2024-01-15T09:30:00Z",
282         "end_at": "2024-12-31T23:59:59Z",
283         "amount": {
284           "quantity": "1000.00",
285           "currency": "AED"
286         }
287       }
288     ],
289     "pricings": [
290       {
291         "ids": [
292           "pricing_002"
293         ],
294         "start_at": "2024-01-15T09:30:00Z",
295         "end_at": "2024-12-31T23:59:59Z",
296         "amount": {
297           "quantity": "1500.00",
298           "currency": "AED"
299         }
300       }
301     ],
302     "totals": [
303       {
304         "start_at": "2024-01-15T09:30:00Z",
305         "end_at": "2024-12-31T23:59:59Z",
306         "amount": {
307           "quantity": "3000.00",
308           "currency": "AED"
309         }
310       }
311     ]
312   },
313   "promotion_codes": [
314     "NEWYEAR2024"
315   ],
316   "coupon_ids": [
317     "coupon_12345"
318   ],
319   "coupon_discount": {
320     "pricing_item_configs": [
321       {
322         "ids": [
323           "pic_004"
324         ],
325         "start_at": "2024-01-15T09:30:00Z",
326         "end_at": "2024-02-15T09:30:00Z",
327         "amount": {
328           "quantity": "20.00",
329           "currency": "AED"
330         },
331         "percentage": "5"
332       }
333     ],
334     "pricing_items": [
335       {
336         "ids": [
337           "pi_003"
338         ],
339         "start_at": "2024-01-15T09:30:00Z",
340         "end_at": "2024-02-15T09:30:00Z",
341         "amount": {
342           "quantity": "10.00",
343           "currency": "AED"
344         },
345         "percentage": "3"
346       }
347     ],
348     "pricings": [
349       {
350         "ids": [
351           "pricing_003"
352         ],
353         "start_at": "2024-01-15T09:30:00Z",
354         "end_at": "2024-02-15T09:30:00Z",
355         "amount": {
356           "quantity": "30.00",
357           "currency": "AED"
358         },
359         "percentage": "8"
360       }
361     ],
362     "totals": [
363       {
364         "start_at": "2024-01-15T09:30:00Z",
365         "end_at": "2024-02-15T09:30:00Z",
366         "amount": {
367           "quantity": "60.00",
368           "currency": "AED"
369         },
370         "percentage": "10",
371         "coupon_id": "coupon_12345",
372         "promotion_code_details": {
373           "promotion_code_id": "promo_abc123",
374           "code": "NEWYEAR2024"
375         }
376       }
377     ],
378     "products": [
379       {
380         "ids": [
381           "prod_002"
382         ],
383         "start_at": "2024-01-15T09:30:00Z",
384         "end_at": "2024-02-15T09:30:00Z",
385         "amount": {
386           "quantity": "12.00",
387           "currency": "AED"
388         },
389         "percentage": "4",
390         "coupon_id": "coupon_12345",
391         "promotion_code_details": {
392           "promotion_code_id": "promo_abc123",
393           "code": "NEWYEAR2024"
394         }
395       }
396     ],
397     "product_items": [
398       {
399         "ids": [
400           "prod_item_002"
401         ],
402         "start_at": "2024-01-15T09:30:00Z",
403         "end_at": "2024-02-15T09:30:00Z",
404         "amount": {
405           "quantity": "8.00",
406           "currency": "AED"
407         },
408         "percentage": "2",
409         "coupon_id": "coupon_12345",
410         "promotion_code_details": {
411           "promotion_code_id": "promo_abc123",
412           "code": "NEWYEAR2024"
413         }
414       }
415     ],
416     "product_categories": [
417       {
418         "ids": [
419           "cat_002"
420         ],
421         "start_at": "2024-01-15T09:30:00Z",
422         "end_at": "2024-02-15T09:30:00Z",
423         "amount": {
424           "quantity": "18.00",
425           "currency": "AED"
426         },
427         "percentage": "6",
428         "coupon_id": "coupon_12345",
429         "promotion_code_details": {
430           "promotion_code_id": "promo_abc123",
431           "code": "NEWYEAR2024"
432         }
433       }
434     ]
435   },
436   "seats_values": [
437     {
438       "pricing_item_config_id": "pic_005",
439       "number": "10",
440       "amount": {
441         "quantity": "100.00",
442         "currency": "AED"
443       },
444       "start_at": "2024-01-15T09:30:00Z",
445       "end_at": "2024-12-31T23:59:59Z"
446     }
447   ],
448   "included_volumes": [
449     {
450       "pricing_item_config_id": "pic_006",
451       "number": "500",
452       "amount": {
453         "quantity": "0.00",
454         "currency": "AED"
455       },
456       "start_at": "2024-01-15T09:30:00Z",
457       "end_at": "2024-12-31T23:59:59Z",
458       "reset_type": "MONTHLY"
459     }
460   ],
461   "enabled_pricings": [
462     {
463       "pricing_id": "pricing_004",
464       "start_at": "2024-01-15T09:30:00Z",
465       "end_at": "2024-12-31T23:59:59Z"
466     }
467   ],
468   "override_pricings": [
469     {
470       "product_ids": [
471         "prod_003"
472       ],
473       "object_type": "pricing_override",
474       "id": "override_001",
475       "pricing_plan_version_id": "ver_2024_04_01",
476       "pricing_plan_schedule_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
477       "pricing_group_id": "group_001",
478       "original_pricing_id": "pricing_005",
479       "original_pricing": {},
480       "override": "ALL",
481       "name": "Override Premium Plan",
482       "product_type": "DEFAULT",
483       "display_order": 1,
484       "products": [
485         {
486           "category_id": "cat_003",
487           "name": "Cloud Storage",
488           "reference": "cloud_storage",
489           "product_type": "DEFAULT",
490           "object_type": "product",
491           "id": "prod_003",
492           "category": {
493             "name": "Cloud Services",
494             "reference": "cloud_services",
495             "object_type": "product_category",
496             "id": "cat_003",
497             "description": "Cloud computing products",
498             "tax_category": "STANDARD",
499             "display_order": 1
500           },
501           "description": "Secure cloud storage service",
502           "status": "ACTIVE",
503           "tax_category": "STANDARD",
504           "features": [
505             {
506               "reference": "storage_limit",
507               "id": "feat_002"
508             }
509           ],
510           "custom_fields": [
511             {
512               "id": "cf_001",
513               "reference": "region_restriction",
514               "value": "EMEA",
515               "values": [
516                 "EMEA"
517               ],
518               "integration_details": {
519                 "payment_gateway_variant": "ADYEN",
520                 "id": "int_001",
521                 "reference": "adyen_integration",
522                 "adyen": {
523                   "recurring_detail_reference": "recurring_123"
524                 },
525                 "stripe": {
526                   "payment_method_id": "pm_123456789"
527                 }
528               }
529             }
530           ],
531           "display_order": 1,
532           "linked_integrations": [
533             {
534               "id": "int_001",
535               "link_details": [
536                 {
537                   "url": "https://integration.example.com/details",
538                   "custom_field_name": "region_restriction"
539                 }
540               ]
541             }
542           ],
543           "billing_entity_id": "be_001"
544         }
545       ],
546       "entitlements": [
547         {
548           "feature_id": "feat_002",
549           "feature": {
550             "reference": "storage_limit",
551             "object_type": "feature",
552             "id": "feat_002",
553             "name": "Storage Limit",
554             "description": "Maximum storage allowed",
555             "type": "SWITCH",
556             "enum_values": [
557               "ENABLED",
558               "DISABLED"
559             ],
560             "meter_value_calculation_id": "calc_002",
561             "meter_value_calculation": {
562               "reference": "storage_usage",
563               "object_type": "meter_value_calculation",
564               "id": "calc_002",
565               "name": "Storage Usage Calculation",
566               "description": "Sum of storage used",
567               "calculation_type": "SUM",
568               "persist": true,
569               "meter_id": "meter_002",
570               "meter": {
571                 "reference": "storage_meter",
572                 "object_type": "meter",
573                 "id": "meter_002",
574                 "name": "Storage Meter",
575                 "description": "Tracks storage usage",
576                 "status": "ACTIVE",
577                 "meter_values": [
578                   {
579                     "id": "mv_002",
580                     "object": {
581                       "reference": "monthly_storage",
582                       "object_type": "meter_value",
583                       "id": "mv_002",
584                       "name": "Monthly Storage",
585                       "description": "Storage used per month",
586                       "status": "ACTIVE",
587                       "type": "NUMBER"
588                     },
589                     "required": true
590                   }
591                 ],
592                 "meter_properties": [
593                   {
594                     "id": "mp_002",
595                     "object": {
596                       "reference": "storage_type",
597                       "status": "ACTIVE",
598                       "object_type": "meter_property",
599                       "id": "mp_002",
600                       "name": "Storage Type",
601                       "description": "Type of storage",
602                       "type": "STRING",
603                       "enum_values": [
604                         "SSD",
605                         "HDD"
606                       ]
607                     },
608                     "required": true
609                   }
610                 ]
611               },
612               "meter_value_id": "mv_002",
613               "meter_value": {
614                 "reference": "monthly_storage",
615                 "object_type": "meter_value",
616                 "id": "mv_002",
617                 "name": "Monthly Storage",
618                 "description": "Storage used per month",
619                 "status": "ACTIVE",
620                 "type": "NUMBER"
621               },
622               "meter_property_id": "mp_002",
623               "meter_property": {
624                 "reference": "storage_type",
625                 "status": "ACTIVE",
626                 "object_type": "meter_property",
627                 "id": "mp_002",
628                 "name": "Storage Type",
629                 "description": "Type of storage",
630                 "type": "STRING",
631                 "enum_values": [
632                   "SSD",
633                   "HDD"
634                 ]
635               }
636             }
637           },
638           "feature_reference": "storage_limit",
639           "override": true,
640           "number": "500",
641           "switch": true,
642           "amount": {
643             "quantity": "0",
644             "currency": "AED"
645           },
646           "enum": "ENABLED",
647           "string": "Enabled",
648           "overwrite": true
649         }
650       ],
651       "items": [],
652       "configs": [],
653       "pricing_currency_configs": [],
654       "billing_period_configs": []
655     }
656   ],
657   "combined_pricing_plan_version": {
658     "object_type": "pricing_plan_version",
659     "id": "ver_2024_04_01",
660     "pricing_plan_id": "plan_1234567890abcdef",
661     "pricing_plan": {
662       "reference": "standard_plan",
663       "amount_type": "EXCLUDING_TAX",
664       "pricing_currencies": [
665         "AED"
666       ],
667       "object_type": "pricing_plan",
668       "id": "plan_1234567890abcdef",
669       "name": "Standard Pricing Plan",
670       "description": "Standard pricing plan for all customers",
671       "customer_id": "cust_001",
672       "type": "STANDARD",
673       "pricing_plan_version_infos": [
674         {
675           "version": 1,
676           "id": "ver_2024_04_01",
677           "status": "ACTIVE",
678           "rate_card": {
679             "start_at": "2024-01-15T09:30:00Z"
680           }
681         }
682       ],
683       "pricing_plan_selection_rules": [
684         {
685           "type": "RESOURCE",
686           "resource": {
687             "type": "PLATFORM",
688             "field": "COUNTRY",
689             "comparator": "EQUALS",
690             "value": "AE",
691             "values": [
692               "AE"
693             ]
694           }
695         }
696       ],
697       "variant": "DEFAULT"
698     },
699     "version": 1,
700     "status": "DRAFT",
701     "pricing_currency_settings": {
702       "default_pricing_currency": "AED",
703       "pricing_currencies": [
704         "AED"
705       ]
706     },
707     "billing_period_settings": {
708       "billing_periods": [
709         {
710           "period": {
711             "type": "DAY",
712             "value": 30
713           },
714           "description": "Monthly billing period"
715         }
716       ]
717     },
718     "pricing_categories": [],
719     "credit_types": [],
720     "rate_card": {
721       "start_at": "2024-01-15T09:30:00Z"
722     },
723     "pricing_groups": [],
724     "display_order": 1
725   },
726   "realign_invoice_date_to_pricing_plan_schedule_start_at": true,
727   "created_at": "2024-01-10T08:00:00Z"
728 }

Requires the PRICING_PLAN_SCHEDULE.VIEW or QUOTE.PRICING_PLAN_SCHEDULE.VIEW permission.

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

pricing_plan_subscription_idstring

Resource ID of type PRICING_PLAN_SUBSCRIPTION

start_atdatetime

object_typestring or nullRead-only

idstring or nullRead-only

typeenum or null

The type of the pricing plan schedule.

Allowed values:

pricing_plan_idstring or null

The resource ID of the pricing plan.

pricing_plan_version_idstring or null

The resource ID of the pricing plan version.

pricing_plan_version_selectorobject

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

end_atdatetime or null

pricing_currencyenum or null

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

billing_periodobject

The renewal term after the initial term.

entitlementslist of objects or null

discountobject or null

markupobject

commitmentobject

promotion_codeslist of strings or null

coupon_idslist of strings or null

coupon_discountobject or null

seats_valueslist of objects or null

included_volumeslist of objects or null

enabled_pricingslist of objects or null

override_pricingslist of objects or null

combined_pricing_plan_versionobject or null

realign_invoice_date_to_pricing_plan_schedule_start_atboolean or null

created_atstring or nullRead-only

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors