curl --request POST \
--url https://sandbox-platform.jupico.com/v1/query/subscriptions \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://sandbox-platform.jupico.com/v1/query/subscriptions"
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', 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';
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>",
"subscriptionId": "<string>",
"planId": "<string>",
"schedules": [
{
"scheduleId": "<string>",
"order": 123,
"label": "<string>",
"invoiceDescription": "<string>",
"frequency": "<string>",
"cyclesQty": 123,
"executionDays": [
123
],
"discount": {
"enabled": true,
"percentage": 123
},
"pricingModel": {
"type": "<string>",
"free": {
"daysQty": 123
},
"flat": {
"price": 123
}
},
"enabled": true
}
],
"executions": [
{
"executionId": "<string>",
"date": "2023-11-07T05:31:56Z",
"amount": 123,
"pricingModel": {
"type": "<string>",
"free": {
"daysQty": 123
},
"flat": {
"price": 123
}
},
"scheduleId": "<string>",
"transactionId": "<string>",
"invoiceId": "<string>",
"status": "<string>"
}
],
"startDate": "2023-11-07T05:31:56Z",
"status": "<string>",
"customerId": "<string>",
"token": "<string>",
"nextExecution": {
"executionId": "<string>",
"date": "2023-11-07T05:31:56Z",
"amount": 123,
"pricingModel": {
"type": "<string>",
"free": {
"daysQty": 123
},
"flat": {
"price": 123
}
},
"scheduleId": "<string>",
"transactionId": "<string>",
"invoiceId": "<string>",
"status": "<string>"
},
"creditCard": {
"_id": "<string>",
"facId": "<string>",
"subMerchantId": "<string>",
"token": "<string>",
"cardHolderName": "<string>",
"expirationMonth": "<string>",
"expirationYear": "<string>",
"cardLogo": "<string>",
"truncatedCardNumber": "<string>"
}
}
]
}List subscriptions
Returns subscriptions, both active and inactive, including their schedules and billing status.
curl --request POST \
--url https://sandbox-platform.jupico.com/v1/query/subscriptions \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://sandbox-platform.jupico.com/v1/query/subscriptions"
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', 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';
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>",
"subscriptionId": "<string>",
"planId": "<string>",
"schedules": [
{
"scheduleId": "<string>",
"order": 123,
"label": "<string>",
"invoiceDescription": "<string>",
"frequency": "<string>",
"cyclesQty": 123,
"executionDays": [
123
],
"discount": {
"enabled": true,
"percentage": 123
},
"pricingModel": {
"type": "<string>",
"free": {
"daysQty": 123
},
"flat": {
"price": 123
}
},
"enabled": true
}
],
"executions": [
{
"executionId": "<string>",
"date": "2023-11-07T05:31:56Z",
"amount": 123,
"pricingModel": {
"type": "<string>",
"free": {
"daysQty": 123
},
"flat": {
"price": 123
}
},
"scheduleId": "<string>",
"transactionId": "<string>",
"invoiceId": "<string>",
"status": "<string>"
}
],
"startDate": "2023-11-07T05:31:56Z",
"status": "<string>",
"customerId": "<string>",
"token": "<string>",
"nextExecution": {
"executionId": "<string>",
"date": "2023-11-07T05:31:56Z",
"amount": 123,
"pricingModel": {
"type": "<string>",
"free": {
"daysQty": 123
},
"flat": {
"price": 123
}
},
"scheduleId": "<string>",
"transactionId": "<string>",
"invoiceId": "<string>",
"status": "<string>"
},
"creditCard": {
"_id": "<string>",
"facId": "<string>",
"subMerchantId": "<string>",
"token": "<string>",
"cardHolderName": "<string>",
"expirationMonth": "<string>",
"expirationYear": "<string>",
"cardLogo": "<string>",
"truncatedCardNumber": "<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 Subscriptions
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.
Unique identifier of the subscription plan.
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.
Pricing model configuration for this schedule.
Hide child attributes
Hide child attributes
The type.
Whether this setting is enabled.
Billing executions for this subscription.
Hide child attributes
Hide child attributes
Identifier of the billing execution.
Invoice issue date (ISO 8601).
The amount of the transaction.
Pricing model configuration for this schedule.
Hide child attributes
Hide child attributes
The type.
Identifier of the plan schedule the subscription uses.
Unique identifier of the original transaction.
Unique identifier of the invoice.
Current status.
Optional first payment date (YYYY-MM-DD). If omitted, payments start immediately.
Current status.
Unique identifier of the customer.
The token value.
Next scheduled billing execution.
Hide child attributes
Hide child attributes
Identifier of the billing execution.
Invoice issue date (ISO 8601).
The amount of the transaction.
Pricing model configuration for this schedule.
Hide child attributes
Hide child attributes
The type.
Identifier of the plan schedule the subscription uses.
Unique identifier of the original transaction.
Unique identifier of the invoice.
Current status.
Credit card acceptance settings.
Hide child attributes
Hide child attributes
Internal document identifier.
Facilitator identifier assigned by Jupico.
Unique identifier of the submerchant.
The token value.
Name of the cardholder.
Two-digit expiration month (01-12).
Two-digit expiration year.
Card brand logo identifier.
Masked card number.
Was this page helpful?

