Update a plan
curl --request POST \
--url https://sandbox-platform.jupico.com/v1/subscriptions/plan/update \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"planId": "<string>",
"subMerchantId": "<string>",
"name": "Black friday test plan",
"description": "Black friday test plan description",
"schedules": [
{
"order": 1,
"label": "Silver",
"invoiceDescription": "Invoice for \"Silver\" schedule.",
"cyclesQty": 3,
"frequency": "monthly",
"executionDays": [
10
],
"pricingModel": {
"type": "flat",
"free": {
"daysQty": 10
},
"flat": {
"price": 100
},
"flatTiered": {
"tiers": [
{
"name": "Basic",
"description": "<string>",
"price": 100,
"featuresSettings": {
"label": "<string>",
"features": [
{
"icon": "<string>",
"name": "<string>",
"description": "<string>",
"link": "<string>"
}
]
}
}
]
},
"perModule": {
"modules": [
{
"name": "Basic",
"description": "<string>",
"price": 100,
"featuresSettings": {
"label": "<string>",
"features": [
{
"icon": "<string>",
"name": "<string>",
"description": "<string>",
"link": "<string>"
}
]
}
}
]
},
"perUsageQuantity": {
"unitPrice": 10
},
"perUsageVolume": {
"steps": [
{
"startQty": 1,
"endQty": 9,
"unitPrice": 15
}
]
},
"perUsageTiered": {
"tiers": [
{
"name": "Basic",
"description": "<string>",
"price": 100,
"featuresSettings": {
"label": "<string>",
"features": [
{
"icon": "<string>",
"name": "<string>",
"description": "<string>",
"link": "<string>"
}
]
}
}
]
}
},
"enabled": true,
"featuresEnabled": false
}
]
}
'import requests
url = "https://sandbox-platform.jupico.com/v1/subscriptions/plan/update"
payload = {
"planId": "<string>",
"subMerchantId": "<string>",
"name": "Black friday test plan",
"description": "Black friday test plan description",
"schedules": [
{
"order": 1,
"label": "Silver",
"invoiceDescription": "Invoice for \"Silver\" schedule.",
"cyclesQty": 3,
"frequency": "monthly",
"executionDays": [10],
"pricingModel": {
"type": "flat",
"free": { "daysQty": 10 },
"flat": { "price": 100 },
"flatTiered": { "tiers": [
{
"name": "Basic",
"description": "<string>",
"price": 100,
"featuresSettings": {
"label": "<string>",
"features": [
{
"icon": "<string>",
"name": "<string>",
"description": "<string>",
"link": "<string>"
}
]
}
}
] },
"perModule": { "modules": [
{
"name": "Basic",
"description": "<string>",
"price": 100,
"featuresSettings": {
"label": "<string>",
"features": [
{
"icon": "<string>",
"name": "<string>",
"description": "<string>",
"link": "<string>"
}
]
}
}
] },
"perUsageQuantity": { "unitPrice": 10 },
"perUsageVolume": { "steps": [
{
"startQty": 1,
"endQty": 9,
"unitPrice": 15
}
] },
"perUsageTiered": { "tiers": [
{
"name": "Basic",
"description": "<string>",
"price": 100,
"featuresSettings": {
"label": "<string>",
"features": [
{
"icon": "<string>",
"name": "<string>",
"description": "<string>",
"link": "<string>"
}
]
}
}
] }
},
"enabled": True,
"featuresEnabled": False
}
]
}
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({
planId: '<string>',
subMerchantId: '<string>',
name: 'Black friday test plan',
description: 'Black friday test plan description',
schedules: [
{
order: 1,
label: 'Silver',
invoiceDescription: 'Invoice for "Silver" schedule.',
cyclesQty: 3,
frequency: 'monthly',
executionDays: [10],
pricingModel: {
type: 'flat',
free: {daysQty: 10},
flat: {price: 100},
flatTiered: {
tiers: [
{
name: 'Basic',
description: '<string>',
price: 100,
featuresSettings: {
label: '<string>',
features: [
{icon: '<string>', name: '<string>', description: '<string>', link: '<string>'}
]
}
}
]
},
perModule: {
modules: [
{
name: 'Basic',
description: '<string>',
price: 100,
featuresSettings: {
label: '<string>',
features: [
{icon: '<string>', name: '<string>', description: '<string>', link: '<string>'}
]
}
}
]
},
perUsageQuantity: {unitPrice: 10},
perUsageVolume: {steps: [{startQty: 1, endQty: 9, unitPrice: 15}]},
perUsageTiered: {
tiers: [
{
name: 'Basic',
description: '<string>',
price: 100,
featuresSettings: {
label: '<string>',
features: [
{icon: '<string>', name: '<string>', description: '<string>', link: '<string>'}
]
}
}
]
}
},
enabled: true,
featuresEnabled: false
}
]
})
};
fetch('https://sandbox-platform.jupico.com/v1/subscriptions/plan/update', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/subscriptions/plan/update';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
planId: '<string>',
subMerchantId: '<string>',
name: 'Black friday test plan',
description: 'Black friday test plan description',
schedules: [
{
order: 1,
label: 'Silver',
invoiceDescription: 'Invoice for "Silver" schedule.',
cyclesQty: 3,
frequency: 'monthly',
executionDays: [10],
pricingModel: {
type: 'flat',
free: {daysQty: 10},
flat: {price: 100},
flatTiered: {
tiers: [
{
name: 'Basic',
description: '<string>',
price: 100,
featuresSettings: {
label: '<string>',
features: [
{icon: '<string>', name: '<string>', description: '<string>', link: '<string>'}
]
}
}
]
},
perModule: {
modules: [
{
name: 'Basic',
description: '<string>',
price: 100,
featuresSettings: {
label: '<string>',
features: [
{icon: '<string>', name: '<string>', description: '<string>', link: '<string>'}
]
}
}
]
},
perUsageQuantity: {unitPrice: 10},
perUsageVolume: {steps: [{startQty: 1, endQty: 9, unitPrice: 15}]},
perUsageTiered: {
tiers: [
{
name: 'Basic',
description: '<string>',
price: 100,
featuresSettings: {
label: '<string>',
features: [
{icon: '<string>', name: '<string>', description: '<string>', link: '<string>'}
]
}
}
]
}
},
enabled: true,
featuresEnabled: false
}
]
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));Subscriptions
Update a plan
Updates an existing subscription plan’s details, schedules, or hosted session settings.
POST
https://sandbox-platform.jupico.com
/
v1
/
subscriptions
/
plan
/
update
Update a plan
curl --request POST \
--url https://sandbox-platform.jupico.com/v1/subscriptions/plan/update \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"planId": "<string>",
"subMerchantId": "<string>",
"name": "Black friday test plan",
"description": "Black friday test plan description",
"schedules": [
{
"order": 1,
"label": "Silver",
"invoiceDescription": "Invoice for \"Silver\" schedule.",
"cyclesQty": 3,
"frequency": "monthly",
"executionDays": [
10
],
"pricingModel": {
"type": "flat",
"free": {
"daysQty": 10
},
"flat": {
"price": 100
},
"flatTiered": {
"tiers": [
{
"name": "Basic",
"description": "<string>",
"price": 100,
"featuresSettings": {
"label": "<string>",
"features": [
{
"icon": "<string>",
"name": "<string>",
"description": "<string>",
"link": "<string>"
}
]
}
}
]
},
"perModule": {
"modules": [
{
"name": "Basic",
"description": "<string>",
"price": 100,
"featuresSettings": {
"label": "<string>",
"features": [
{
"icon": "<string>",
"name": "<string>",
"description": "<string>",
"link": "<string>"
}
]
}
}
]
},
"perUsageQuantity": {
"unitPrice": 10
},
"perUsageVolume": {
"steps": [
{
"startQty": 1,
"endQty": 9,
"unitPrice": 15
}
]
},
"perUsageTiered": {
"tiers": [
{
"name": "Basic",
"description": "<string>",
"price": 100,
"featuresSettings": {
"label": "<string>",
"features": [
{
"icon": "<string>",
"name": "<string>",
"description": "<string>",
"link": "<string>"
}
]
}
}
]
}
},
"enabled": true,
"featuresEnabled": false
}
]
}
'import requests
url = "https://sandbox-platform.jupico.com/v1/subscriptions/plan/update"
payload = {
"planId": "<string>",
"subMerchantId": "<string>",
"name": "Black friday test plan",
"description": "Black friday test plan description",
"schedules": [
{
"order": 1,
"label": "Silver",
"invoiceDescription": "Invoice for \"Silver\" schedule.",
"cyclesQty": 3,
"frequency": "monthly",
"executionDays": [10],
"pricingModel": {
"type": "flat",
"free": { "daysQty": 10 },
"flat": { "price": 100 },
"flatTiered": { "tiers": [
{
"name": "Basic",
"description": "<string>",
"price": 100,
"featuresSettings": {
"label": "<string>",
"features": [
{
"icon": "<string>",
"name": "<string>",
"description": "<string>",
"link": "<string>"
}
]
}
}
] },
"perModule": { "modules": [
{
"name": "Basic",
"description": "<string>",
"price": 100,
"featuresSettings": {
"label": "<string>",
"features": [
{
"icon": "<string>",
"name": "<string>",
"description": "<string>",
"link": "<string>"
}
]
}
}
] },
"perUsageQuantity": { "unitPrice": 10 },
"perUsageVolume": { "steps": [
{
"startQty": 1,
"endQty": 9,
"unitPrice": 15
}
] },
"perUsageTiered": { "tiers": [
{
"name": "Basic",
"description": "<string>",
"price": 100,
"featuresSettings": {
"label": "<string>",
"features": [
{
"icon": "<string>",
"name": "<string>",
"description": "<string>",
"link": "<string>"
}
]
}
}
] }
},
"enabled": True,
"featuresEnabled": False
}
]
}
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({
planId: '<string>',
subMerchantId: '<string>',
name: 'Black friday test plan',
description: 'Black friday test plan description',
schedules: [
{
order: 1,
label: 'Silver',
invoiceDescription: 'Invoice for "Silver" schedule.',
cyclesQty: 3,
frequency: 'monthly',
executionDays: [10],
pricingModel: {
type: 'flat',
free: {daysQty: 10},
flat: {price: 100},
flatTiered: {
tiers: [
{
name: 'Basic',
description: '<string>',
price: 100,
featuresSettings: {
label: '<string>',
features: [
{icon: '<string>', name: '<string>', description: '<string>', link: '<string>'}
]
}
}
]
},
perModule: {
modules: [
{
name: 'Basic',
description: '<string>',
price: 100,
featuresSettings: {
label: '<string>',
features: [
{icon: '<string>', name: '<string>', description: '<string>', link: '<string>'}
]
}
}
]
},
perUsageQuantity: {unitPrice: 10},
perUsageVolume: {steps: [{startQty: 1, endQty: 9, unitPrice: 15}]},
perUsageTiered: {
tiers: [
{
name: 'Basic',
description: '<string>',
price: 100,
featuresSettings: {
label: '<string>',
features: [
{icon: '<string>', name: '<string>', description: '<string>', link: '<string>'}
]
}
}
]
}
},
enabled: true,
featuresEnabled: false
}
]
})
};
fetch('https://sandbox-platform.jupico.com/v1/subscriptions/plan/update', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/subscriptions/plan/update';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
planId: '<string>',
subMerchantId: '<string>',
name: 'Black friday test plan',
description: 'Black friday test plan description',
schedules: [
{
order: 1,
label: 'Silver',
invoiceDescription: 'Invoice for "Silver" schedule.',
cyclesQty: 3,
frequency: 'monthly',
executionDays: [10],
pricingModel: {
type: 'flat',
free: {daysQty: 10},
flat: {price: 100},
flatTiered: {
tiers: [
{
name: 'Basic',
description: '<string>',
price: 100,
featuresSettings: {
label: '<string>',
features: [
{icon: '<string>', name: '<string>', description: '<string>', link: '<string>'}
]
}
}
]
},
perModule: {
modules: [
{
name: 'Basic',
description: '<string>',
price: 100,
featuresSettings: {
label: '<string>',
features: [
{icon: '<string>', name: '<string>', description: '<string>', link: '<string>'}
]
}
}
]
},
perUsageQuantity: {unitPrice: 10},
perUsageVolume: {steps: [{startQty: 1, endQty: 9, unitPrice: 15}]},
perUsageTiered: {
tiers: [
{
name: 'Basic',
description: '<string>',
price: 100,
featuresSettings: {
label: '<string>',
features: [
{icon: '<string>', name: '<string>', description: '<string>', link: '<string>'}
]
}
}
]
}
},
enabled: true,
featuresEnabled: false
}
]
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
The planId that ident the subscription plan
The subMerchantId associated with the plan.
Plan's name.
Example:
"Black friday test plan"
Plan's description.
Example:
"Black friday test plan description"
Array containing plan's schedules.
Show child attributes
Show child attributes
Plan's title.
Example:
""
Plan's sub title.
Example:
""
Object to edit configuration of created hosted session.
Show child attributes
Show child attributes
Response
Plan successfully created.
Last modified on July 14, 2026
Was this page helpful?
⌘I

