| Response Structure |
: |
{
"status_code": 200,
"status_message": "OK",
"message": "subscriptionDetailsRetrievedSuccessfully",
"is_data": true,
"data": {
"subscriptionUuid": "String",
"status": "String",
"subscriptionSummary": {
"subscriptionAmount": "Float",
"amountPaid": "Float",
"amountRefunded": "Float",
"amountInBank": "Float",
"startDate": "String",
"endDate": "String",
"dueDateForPaymentLink": "String",
"payablePerCycle": "Integer",
"frequency": "String",
"repeats": "Integer",
"currency": "String",
"currentCycle": "String",
"isPaid": "Boolean",
"isRefundable": "Boolean"
},
"productList": [
{
"id": "Integer",
"productName": "String",
"productId": "null|String",
"quantity": "Integer",
"rate": "Float",
"discount": "Integer",
"tax": "Integer",
"amount": "Float"
}
],
"sendOrderBy": {
"sms": "Boolean",
"email": "Boolean"
},
"customerDetails": {
"customerUuid": "String",
"customerName": "String",
"customerEmail": "String",
"countryCode": "String",
"msisdn": "String",
"preferredLanguage": "String",
"address": {
"street": "String",
"zip": "String",
"city": "String",
"country": "String"
}
},
"organizationDetails": {
"name": "String",
"billingAddress": {
"countryCode": "String",
"msisdn": "String",
"email": "String",
"street": "String",
"zip": "String",
"city": "String",
"country": "String"
}
},
"subscriptionCycles": {
"Cycle 1": {
"reference": "String",
"status": "String",
"invoiced": "Boolean",
"amount": "Float",
"startDate": "String",
"endDate": "String",
"isRefunded": "Boolean",
"refundedAt": "null|String",
"refundedAmount": "Float"
}
},
"customerNote": "null|String",
"termsAndConditions": "null|String"
}
}
|
| Example Response |
: |
{
"status_code": 200,
"status_message": "OK",
"message": "subscriptionDetailsRetrievedSuccessfully",
"is_data": true,
"data": {
"logs": [
{
"subscriptionUuid": "SUB1087613902",
"orderUuid"status": "ODR434476639",
"cycle": "Cycle 1",
"currency": "NOK",
"orderAmount": 100,
"paymentMethod": "BAMBORA",
"action": "SUBSCRIPTION_CAPTURED",
"translateKey": "subscriptionLogSubscriptionCaptured",
"actionBy": "SYSTEM",
"createdAt": "11.09.2023",
"countryCode": "+47",
"msisdn": "46567468",
"note": "",
"organizationBusinessId": "925710482",
"title": "Subscription Captured",
"slug": "subscription-captured",
"refundAmount": 0
},
{
"subscriptionUuid": "SUB1087613902",
"orderUuid": "ODR434476639",
"cycle": "Cycle 1",
"currency": "NOK",
"orderAmount": 100,
"paymentMethod": "BAMBORA",
"action": "SUBSCRIPTION_CREATED",
"translateKey": "subscriptionLogSubscriptionCreated",
"actionBy": "Joni",
"createdAt": "10.09.2023",
"countryCode": "+47",
"msisdn": "46567468",
"note": "",
"organizationBusinessId": "925710482",
"title": "Subscription Created",
"slug": "subscription-created",
"refundAmount": 0
}
]ONGOING",
"subscriptionSummary": {
"subscriptionAmount": 100,
"amountPaid": 100,2600,
"amountRefunded": 0,
"amountInBank": 100
},
"subscription": {
"uuid": "SUB1087613902",
"orderUuid": "ODR434476639",2600,
"startDate": "10.09.2023",
"endDate": "09.03.2023",
"dueDateForPaymentLink": "07:13, 12.09.2023",
"sendOrderViaSms": 0,
"sendOrderViaEmail": 1,
"customerNote": null,
"termsAndConditions": null,
"subTotal": 100,
"discount": 0,
"tax": 0,
"payablePerCycle": 100,
"currency": "NOK",
"frequency": "monthly",
"repeats": 6,30,
"currency": "NOK",
"currentCycle": "Cycle 1"26",
"status": "ONGOING",
"numberOfOrder": 1,
"isPaid": true,
"isRefundable": true,true
"translationKey": "subscriptionStatusOngoing"},
"products"productList": [
{
"id": 1035,
"productName": "Test Service",
"productId": "S001",
"quantity": 1,
"rate": 100,
"discount": 0,
"tax": 0,
"amount": 100
}
],
"sendOrderBy": {
"sms": false,
"email": true
},
"customer"customerDetails": {
"customerUuid": "CSRT3798554634",
"customerName": "420 Test",
"customerEmail": "local-[email protected]",
"countryCode": "+47",
"msisdn": "46567468",
"preferredLanguage": "no",
"address": {
"street": "Mirpur-14",
"zip": "3500",
"city": "Dhaka",
"country": "norway",
"preferredLanguage": "no"}
},
"organization"organizationDetails": {
"name": "Front Payment AS",
"address"billingAddress": {
"street": "Anders Hovdens Vei 9",
"countryCode": "+47",
"country": "norway",
"city": "Stavanger ",
"zip": "4026",
"msisdn": "98098405",
"email": "[email protected]",
"street": "Anders Hovdens Vei 9",
"zip": "4026",
"city": "Stavanger ",
"country": "norway"
}
},
"refundCycles"subscriptionCycles": {
"cycles"Cycle 1": [ {
"cycleName"reference": "CycleODR434476639",
1""status": "PAID",
"invoiced": false,
"amount": 100,
"startDate": "10.09.2023",
"endDate": "09.10.2023"
}
],
"subscriptionUuid"isRefunded": false,
"refundedAt": null,
"refundedAmount": 0
},
"Cycle 2": {
"reference": "SUB1087613902"ODR3759688884",
"organizationName"status": "Front Payment AS"PAID",
"payablePerMonth"invoiced": false,
"amount": 100,
"frequency"startDate": "monthly"01.11.2023",
"endDate": "30.11.2023",
"isRefunded": false,
"refundedAt": null,
"refundedAmount": 0
},
"Cycle 3": {
"reference": "ODR2701395834",
"status": "PAID",
"invoiced": false,
"amount": 100,
"startDate": "01.11.2023",
"endDate": "30.11.2023",
"isRefunded": false,
"refundedAt": null,
"refundedAmount": 0
},
"Cycle 4": {
"reference": "ODR608898249",
"status": "PAID",
"invoiced": false,
"amount": 100,
"startDate": "01.11.2023",
"endDate": "30.11.2023",
"isRefunded": false,
"refundedAt": null,
"refundedAmount": 0
}
},
"customerNote": null,
"termsAndConditions": null
}
}
|
