POST v1/customers/{customerId}/subscriptionProductSearch
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| customerId | integer |
Required |
Body Parameters
Common.Dto.Post.SubscriptionProductSearch| Name | Description | Type | Additional information |
|---|---|---|---|
| products | Collection of Common.Dto.Post.SubscriptionProductSearch+ProductQuery |
None. |
Request Formats
application/json, text/json
Sample:
{
"products": [
{
"productId": 1,
"reference": "sample string 2",
"customFields": [
{
"key": "sample string 1",
"value": {},
"operator": "sample string 3"
},
{
"key": "sample string 1",
"value": {},
"operator": "sample string 3"
}
]
},
{
"productId": 1,
"reference": "sample string 2",
"customFields": [
{
"key": "sample string 1",
"value": {},
"operator": "sample string 3"
},
{
"key": "sample string 1",
"value": {},
"operator": "sample string 3"
}
]
}
]
}
Response Information
Resource Description
Common.Dto.Get.SubscriptionProductSearch| Name | Description | Type | Additional information |
|---|---|---|---|
| customerId | integer |
None. |
|
| products | Collection of Common.Dto.Get.SubscriptionProductSearch+ProductResult |
None. |
Response Formats
application/json, text/json
Sample:
{
"customerId": 1,
"products": [
{
"productId": 1,
"productName": "sample string 2",
"product": {
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"customFields": [
{
"id": 1,
"customFieldId": 1,
"key": "sample string 1",
"friendlyName": "sample string 2",
"dataType": "sample string 3",
"defaultValue": {}
},
{
"id": 1,
"customFieldId": 1,
"key": "sample string 1",
"friendlyName": "sample string 2",
"dataType": "sample string 3",
"defaultValue": {}
}
],
"id": 4,
"uri": "sample string 5"
},
"reference": "sample string 3",
"isPurchased": {
"referenceExists": true
},
"subscriptions": [
{
"id": 1,
"customerId": 2,
"planName": "sample string 3",
"planDescription": "sample string 4",
"planCode": "sample string 5",
"reference": "sample string 6",
"subscriptionProducts": [
{
"id": 1,
"productCode": "sample string 2",
"productName": "sample string 3",
"isIncluded": true,
"price": 5.0,
"priceOverride": {
"chargeAmount": 1.0,
"priceRanges": [
{
"min": 1.0,
"max": 1.0,
"price": 2.0
},
{
"min": 1.0,
"max": 1.0,
"price": 2.0
}
],
"pricingModelType": "sample string 2",
"id": 3,
"uri": "sample string 4"
},
"discount": {
"discountType": "sample string 1",
"amount": 2.0,
"remainingUsagesUntilStart": 3,
"remainingUsage": 1,
"id": 4,
"uri": "sample string 5"
},
"customFields": [
{
"key": "sample string 1",
"friendlyName": "sample string 2",
"dataType": "sample string 3",
"value": {}
},
{
"key": "sample string 1",
"friendlyName": "sample string 2",
"dataType": "sample string 3",
"value": {}
}
]
},
{
"id": 1,
"productCode": "sample string 2",
"productName": "sample string 3",
"isIncluded": true,
"price": 5.0,
"priceOverride": {
"chargeAmount": 1.0,
"priceRanges": [
{
"min": 1.0,
"max": 1.0,
"price": 2.0
},
{
"min": 1.0,
"max": 1.0,
"price": 2.0
}
],
"pricingModelType": "sample string 2",
"id": 3,
"uri": "sample string 4"
},
"discount": {
"discountType": "sample string 1",
"amount": 2.0,
"remainingUsagesUntilStart": 3,
"remainingUsage": 1,
"id": 4,
"uri": "sample string 5"
},
"customFields": [
{
"key": "sample string 1",
"friendlyName": "sample string 2",
"dataType": "sample string 3",
"value": {}
},
{
"key": "sample string 1",
"friendlyName": "sample string 2",
"dataType": "sample string 3",
"value": {}
}
]
}
]
},
{
"id": 1,
"customerId": 2,
"planName": "sample string 3",
"planDescription": "sample string 4",
"planCode": "sample string 5",
"reference": "sample string 6",
"subscriptionProducts": [
{
"id": 1,
"productCode": "sample string 2",
"productName": "sample string 3",
"isIncluded": true,
"price": 5.0,
"priceOverride": {
"chargeAmount": 1.0,
"priceRanges": [
{
"min": 1.0,
"max": 1.0,
"price": 2.0
},
{
"min": 1.0,
"max": 1.0,
"price": 2.0
}
],
"pricingModelType": "sample string 2",
"id": 3,
"uri": "sample string 4"
},
"discount": {
"discountType": "sample string 1",
"amount": 2.0,
"remainingUsagesUntilStart": 3,
"remainingUsage": 1,
"id": 4,
"uri": "sample string 5"
},
"customFields": [
{
"key": "sample string 1",
"friendlyName": "sample string 2",
"dataType": "sample string 3",
"value": {}
},
{
"key": "sample string 1",
"friendlyName": "sample string 2",
"dataType": "sample string 3",
"value": {}
}
]
},
{
"id": 1,
"productCode": "sample string 2",
"productName": "sample string 3",
"isIncluded": true,
"price": 5.0,
"priceOverride": {
"chargeAmount": 1.0,
"priceRanges": [
{
"min": 1.0,
"max": 1.0,
"price": 2.0
},
{
"min": 1.0,
"max": 1.0,
"price": 2.0
}
],
"pricingModelType": "sample string 2",
"id": 3,
"uri": "sample string 4"
},
"discount": {
"discountType": "sample string 1",
"amount": 2.0,
"remainingUsagesUntilStart": 3,
"remainingUsage": 1,
"id": 4,
"uri": "sample string 5"
},
"customFields": [
{
"key": "sample string 1",
"friendlyName": "sample string 2",
"dataType": "sample string 3",
"value": {}
},
{
"key": "sample string 1",
"friendlyName": "sample string 2",
"dataType": "sample string 3",
"value": {}
}
]
}
]
}
]
},
{
"productId": 1,
"productName": "sample string 2",
"product": {
"code": "sample string 1",
"name": "sample string 2",
"price": 3.0,
"customFields": [
{
"id": 1,
"customFieldId": 1,
"key": "sample string 1",
"friendlyName": "sample string 2",
"dataType": "sample string 3",
"defaultValue": {}
},
{
"id": 1,
"customFieldId": 1,
"key": "sample string 1",
"friendlyName": "sample string 2",
"dataType": "sample string 3",
"defaultValue": {}
}
],
"id": 4,
"uri": "sample string 5"
},
"reference": "sample string 3",
"isPurchased": {
"referenceExists": true
},
"subscriptions": [
{
"id": 1,
"customerId": 2,
"planName": "sample string 3",
"planDescription": "sample string 4",
"planCode": "sample string 5",
"reference": "sample string 6",
"subscriptionProducts": [
{
"id": 1,
"productCode": "sample string 2",
"productName": "sample string 3",
"isIncluded": true,
"price": 5.0,
"priceOverride": {
"chargeAmount": 1.0,
"priceRanges": [
{
"min": 1.0,
"max": 1.0,
"price": 2.0
},
{
"min": 1.0,
"max": 1.0,
"price": 2.0
}
],
"pricingModelType": "sample string 2",
"id": 3,
"uri": "sample string 4"
},
"discount": {
"discountType": "sample string 1",
"amount": 2.0,
"remainingUsagesUntilStart": 3,
"remainingUsage": 1,
"id": 4,
"uri": "sample string 5"
},
"customFields": [
{
"key": "sample string 1",
"friendlyName": "sample string 2",
"dataType": "sample string 3",
"value": {}
},
{
"key": "sample string 1",
"friendlyName": "sample string 2",
"dataType": "sample string 3",
"value": {}
}
]
},
{
"id": 1,
"productCode": "sample string 2",
"productName": "sample string 3",
"isIncluded": true,
"price": 5.0,
"priceOverride": {
"chargeAmount": 1.0,
"priceRanges": [
{
"min": 1.0,
"max": 1.0,
"price": 2.0
},
{
"min": 1.0,
"max": 1.0,
"price": 2.0
}
],
"pricingModelType": "sample string 2",
"id": 3,
"uri": "sample string 4"
},
"discount": {
"discountType": "sample string 1",
"amount": 2.0,
"remainingUsagesUntilStart": 3,
"remainingUsage": 1,
"id": 4,
"uri": "sample string 5"
},
"customFields": [
{
"key": "sample string 1",
"friendlyName": "sample string 2",
"dataType": "sample string 3",
"value": {}
},
{
"key": "sample string 1",
"friendlyName": "sample string 2",
"dataType": "sample string 3",
"value": {}
}
]
}
]
},
{
"id": 1,
"customerId": 2,
"planName": "sample string 3",
"planDescription": "sample string 4",
"planCode": "sample string 5",
"reference": "sample string 6",
"subscriptionProducts": [
{
"id": 1,
"productCode": "sample string 2",
"productName": "sample string 3",
"isIncluded": true,
"price": 5.0,
"priceOverride": {
"chargeAmount": 1.0,
"priceRanges": [
{
"min": 1.0,
"max": 1.0,
"price": 2.0
},
{
"min": 1.0,
"max": 1.0,
"price": 2.0
}
],
"pricingModelType": "sample string 2",
"id": 3,
"uri": "sample string 4"
},
"discount": {
"discountType": "sample string 1",
"amount": 2.0,
"remainingUsagesUntilStart": 3,
"remainingUsage": 1,
"id": 4,
"uri": "sample string 5"
},
"customFields": [
{
"key": "sample string 1",
"friendlyName": "sample string 2",
"dataType": "sample string 3",
"value": {}
},
{
"key": "sample string 1",
"friendlyName": "sample string 2",
"dataType": "sample string 3",
"value": {}
}
]
},
{
"id": 1,
"productCode": "sample string 2",
"productName": "sample string 3",
"isIncluded": true,
"price": 5.0,
"priceOverride": {
"chargeAmount": 1.0,
"priceRanges": [
{
"min": 1.0,
"max": 1.0,
"price": 2.0
},
{
"min": 1.0,
"max": 1.0,
"price": 2.0
}
],
"pricingModelType": "sample string 2",
"id": 3,
"uri": "sample string 4"
},
"discount": {
"discountType": "sample string 1",
"amount": 2.0,
"remainingUsagesUntilStart": 3,
"remainingUsage": 1,
"id": 4,
"uri": "sample string 5"
},
"customFields": [
{
"key": "sample string 1",
"friendlyName": "sample string 2",
"dataType": "sample string 3",
"value": {}
},
{
"key": "sample string 1",
"friendlyName": "sample string 2",
"dataType": "sample string 3",
"value": {}
}
]
}
]
}
]
}
]
}