curl --request POST \
--url https://sandbox-platform.jupico.com/v1/query/subscriptions/plan \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://sandbox-platform.jupico.com/v1/query/subscriptions/plan"
payload = {}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://sandbox-platform.jupico.com/v1/query/subscriptions/plan', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/query/subscriptions/plan';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"message": "<string>",
"code": "<string>",
"data": [
{
"_id": "<string>",
"facId": "<string>",
"spProductId": "<string>",
"subMerchantId": "<string>",
"planId": "<string>",
"hostedSession": {
"hostedSessionId": "<string>",
"url": "<string>"
},
"name": "<string>",
"description": "<string>",
"schedules": [
{
"scheduleId": "<string>",
"order": 123,
"label": "<string>",
"invoiceDescription": "<string>",
"frequency": "<string>",
"cyclesQty": 123,
"executionDays": [
123
],
"unit": "<string>",
"discount": {
"percentage": 123
},
"pricingModel": {
"type": "<string>",
"free": {
"daysQty": 123
},
"flat": {
"price": 123
},
"flatTiered": {
"tiers": [
{
"tierId": "<string>",
"name": "<string>",
"description": "<string>",
"price": 123,
"featuresSettings": {
"label": "<string>",
"features": [
{
"name": "<string>",
"description": "<string>"
}
]
}
}
]
},
"perModule": {
"modules": [
{
"moduleId": "<string>",
"name": "<string>",
"description": "<string>",
"price": 123
}
]
},
"perUsageQuantity": {
"unitPrice": 123
},
"perUsageVolume": {
"steps": [
{
"stepId": "<string>",
"startQty": 123,
"endQty": 123,
"unitPrice": 123
}
]
},
"perUsageTiered": {
"tiers": [
{
"tierId": "<string>",
"name": "<string>",
"description": "<string>",
"unitPrice": 123,
"quantitySettings": {
"tiers": [
123
]
}
}
]
}
}
}
],
"status": "<string>",
"subscribersQuantity": 123,
"subMerchantDbaName": "<string>"
}
]
}List plans
Returns subscription plans with their schedules and pricing configuration.
curl --request POST \
--url https://sandbox-platform.jupico.com/v1/query/subscriptions/plan \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://sandbox-platform.jupico.com/v1/query/subscriptions/plan"
payload = {}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://sandbox-platform.jupico.com/v1/query/subscriptions/plan', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/query/subscriptions/plan';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"message": "<string>",
"code": "<string>",
"data": [
{
"_id": "<string>",
"facId": "<string>",
"spProductId": "<string>",
"subMerchantId": "<string>",
"planId": "<string>",
"hostedSession": {
"hostedSessionId": "<string>",
"url": "<string>"
},
"name": "<string>",
"description": "<string>",
"schedules": [
{
"scheduleId": "<string>",
"order": 123,
"label": "<string>",
"invoiceDescription": "<string>",
"frequency": "<string>",
"cyclesQty": 123,
"executionDays": [
123
],
"unit": "<string>",
"discount": {
"percentage": 123
},
"pricingModel": {
"type": "<string>",
"free": {
"daysQty": 123
},
"flat": {
"price": 123
},
"flatTiered": {
"tiers": [
{
"tierId": "<string>",
"name": "<string>",
"description": "<string>",
"price": 123,
"featuresSettings": {
"label": "<string>",
"features": [
{
"name": "<string>",
"description": "<string>"
}
]
}
}
]
},
"perModule": {
"modules": [
{
"moduleId": "<string>",
"name": "<string>",
"description": "<string>",
"price": 123
}
]
},
"perUsageQuantity": {
"unitPrice": 123
},
"perUsageVolume": {
"steps": [
{
"stepId": "<string>",
"startQty": 123,
"endQty": 123,
"unitPrice": 123
}
]
},
"perUsageTiered": {
"tiers": [
{
"tierId": "<string>",
"name": "<string>",
"description": "<string>",
"unitPrice": 123,
"quantitySettings": {
"tiers": [
123
]
}
}
]
}
}
}
],
"status": "<string>",
"subscribersQuantity": 123,
"subMerchantDbaName": "<string>"
}
]
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
The body is of type object.
Response
Find Plans
Whether the request was processed successfully. Declines return HTTP 200 with success: false.
Human-readable result message.
Machine-readable result code. See the Error Codes reference.
The response payload.
Hide child attributes
Hide child attributes
Internal document identifier.
Facilitator identifier assigned by Jupico.
Identifier of the Service Provider product the merchant belongs to.
Unique identifier of the submerchant.
Unique identifier of the subscription plan.
Display name.
Free-text description.
Billing schedules for the plan.
Hide child attributes
Hide child attributes
Identifier of the plan schedule the subscription uses.
Display order, starting at 1.
Display label for this schedule.
Description shown on invoices generated by this schedule.
Billing frequency.
Number of billing cycles before the schedule ends.
Days on which scheduled charges execute.
Unit label for usage-based pricing.
Pricing model configuration for this schedule.
Hide child attributes
Hide child attributes
The type.
Flat pricing with selectable tiers.
Hide child attributes
Hide child attributes
Available tiers for this schedule.
Hide child attributes
Hide child attributes
Identifier of the tier.
Display name of the tier.
Description of the tier shown to the customer.
Price of the tier per billing cycle.
Display settings for the tier's feature list.
Hide child attributes
Hide child attributes
Heading displayed above the feature list.
Per-module pricing: the customer subscribes to individual modules.
Hide child attributes
Hide child attributes
Modules available for subscription.
Hide child attributes
Hide child attributes
Identifier of the module.
Display name.
Free-text description.
Price per billing cycle.
Usage-based pricing where the unit price depends on total volume.
Hide child attributes
Hide child attributes
Volume pricing steps.
Hide child attributes
Hide child attributes
Identifier of the volume step.
First unit quantity this step applies to.
Last unit quantity this step applies to.
Price per unit within this volume step.
Usage-based pricing with tiered rates per volume step.
Hide child attributes
Hide child attributes
Available tiers for this schedule.
Hide child attributes
Hide child attributes
Identifier of the tier.
Display name of the tier.
Description of the tier shown to the customer.
Price per unit.
Current status.
Number of active subscribers on this plan.
DBA name of the submerchant that owns the plan.
Was this page helpful?

