Get Subscription by ID
The “Get Subscription by ID” API allows to retrieve information for a specific subscription using its unique identifier. Use this endpoint to fetch details for a single subscription based on the provided subscription ID.
GET
/
payments
/
subscriptions
/
{subscriptionId}
Get Subscription by ID
curl --request GET \
--url https://services.leadconnectorhq.com/payments/subscriptions/{subscriptionId} \
--header 'Version: <version>'const options = {method: 'GET', headers: {Version: '<version>'}};
fetch('https://services.leadconnectorhq.com/payments/subscriptions/{subscriptionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://services.leadconnectorhq.com/payments/subscriptions/{subscriptionId}"
headers = {"Version": "<version>"}
response = requests.get(url, headers=headers)
print(response.text){
"_id": "64bf78af39118e4011926cba",
"altType": "location",
"altId": "3SwdhCu3svxI8AKsPJt6",
"createdAt": "2023-11-20T10:23:36.515Z",
"updatedAt": "2024-01-23T09:57:04.846Z",
"contactId": "XPLSw2SVagl12LMDeTmQ",
"contactSnapshot": "{ last_name: \"Mcclain\", type: \"lead\", first_name_lower_case: \"rogan\", email: \"anish+11@hoopai.com\", last_name_lower_case: \"mcclain\", location_id: \"o6241QsiRwUIJHyjuhos\", company_name: \"Jordan and Cox Trading\"}",
"coupon": "{ _id: \"6374c6926d119a393fe1e556\", usageCount: 5260, altId: \"jVFIxsMY19D94nOSIOEO\", altType: \"location\", name: \"FREE-100%\", code: \"FREE100\", discountType: \"percentage\", discountValue: 100 }",
"currency": "USD",
"amount": "100",
"status": "active",
"liveMode": "false",
"entityType": "order",
"entityId": "62f4db0f3059ecee61379012",
"entitySource": "{ type: \"funnel\", id: \"lx6ROqruHGVQD2PZwFxK\", subType: \"upsell\", name: \"test funnel\" }",
"subscriptionId": "I-0UE609H8E43P",
"subscriptionSnapshot": "{ status: \"ACTIVE\", status_update_time: \"2022-08-16T11:06:53Z\", id: \"I-0UE609H8E43P\", plan_id: \"P-82K11750F0313430KMLRGE6Y\", start_time: \"2022-08-16T11:05:31Z\", quantity: 1 }",
"paymentProvider": "{ type: \"paypal\", connectedAccount: { _id: \"64410debdc8f3b0503523abb\", merchantClientId: \"AeXtjrxdgsJiCPwQt5jML5pH-0mwmLs-tH7ub4Uo3IrDKvRl34FvJy8niI6E1wmS_pryIRdNllyVl58b\" } }",
"ipAddress": "103.100.16.82",
"meta": "{ collection: \"transactionsv2\", id: \"6320652f0f664b6632006920\" }",
"markAsTest": "false",
"schedule": "{ collection: \"transactionsv2\", id: \"6320652f0f664b6632006920\" }",
"autoPayment": "{ customerId: \"908879612\", paymentMethodId: \"908646635\" }",
"recurringProduct": "{ locationId: \"Z4Bxl8J4SaPEPLq9IQ8g\", funnel: \"bQHJWKcyjiKjk4BHv91g\", step: \"2281a993-8a75-4b48-9912-571f29c99a74\", name: \"Sofa Set\" }",
"canceledAt": "2023-11-20T10:23:36.515Z",
"canceledBy": "qUuXUiB2AiA2DIthEicP",
"traceId": "302d2cf4-1ba0-4bf5-bc3b-f8fa76fda58a",
"createdBy": "user123"
}{
"statusCode": 400,
"message": "Bad Request"
}{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}{
"statusCode": 422,
"message": [
"Unprocessable Entity"
],
"error": "Unprocessable Entity"
}Path Parameters
Query Parameters
Response
Successful response
Last modified on March 8, 2026
Was this page helpful?
Get Subscription by ID
curl --request GET \
--url https://services.leadconnectorhq.com/payments/subscriptions/{subscriptionId} \
--header 'Version: <version>'const options = {method: 'GET', headers: {Version: '<version>'}};
fetch('https://services.leadconnectorhq.com/payments/subscriptions/{subscriptionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://services.leadconnectorhq.com/payments/subscriptions/{subscriptionId}"
headers = {"Version": "<version>"}
response = requests.get(url, headers=headers)
print(response.text){
"_id": "64bf78af39118e4011926cba",
"altType": "location",
"altId": "3SwdhCu3svxI8AKsPJt6",
"createdAt": "2023-11-20T10:23:36.515Z",
"updatedAt": "2024-01-23T09:57:04.846Z",
"contactId": "XPLSw2SVagl12LMDeTmQ",
"contactSnapshot": "{ last_name: \"Mcclain\", type: \"lead\", first_name_lower_case: \"rogan\", email: \"anish+11@hoopai.com\", last_name_lower_case: \"mcclain\", location_id: \"o6241QsiRwUIJHyjuhos\", company_name: \"Jordan and Cox Trading\"}",
"coupon": "{ _id: \"6374c6926d119a393fe1e556\", usageCount: 5260, altId: \"jVFIxsMY19D94nOSIOEO\", altType: \"location\", name: \"FREE-100%\", code: \"FREE100\", discountType: \"percentage\", discountValue: 100 }",
"currency": "USD",
"amount": "100",
"status": "active",
"liveMode": "false",
"entityType": "order",
"entityId": "62f4db0f3059ecee61379012",
"entitySource": "{ type: \"funnel\", id: \"lx6ROqruHGVQD2PZwFxK\", subType: \"upsell\", name: \"test funnel\" }",
"subscriptionId": "I-0UE609H8E43P",
"subscriptionSnapshot": "{ status: \"ACTIVE\", status_update_time: \"2022-08-16T11:06:53Z\", id: \"I-0UE609H8E43P\", plan_id: \"P-82K11750F0313430KMLRGE6Y\", start_time: \"2022-08-16T11:05:31Z\", quantity: 1 }",
"paymentProvider": "{ type: \"paypal\", connectedAccount: { _id: \"64410debdc8f3b0503523abb\", merchantClientId: \"AeXtjrxdgsJiCPwQt5jML5pH-0mwmLs-tH7ub4Uo3IrDKvRl34FvJy8niI6E1wmS_pryIRdNllyVl58b\" } }",
"ipAddress": "103.100.16.82",
"meta": "{ collection: \"transactionsv2\", id: \"6320652f0f664b6632006920\" }",
"markAsTest": "false",
"schedule": "{ collection: \"transactionsv2\", id: \"6320652f0f664b6632006920\" }",
"autoPayment": "{ customerId: \"908879612\", paymentMethodId: \"908646635\" }",
"recurringProduct": "{ locationId: \"Z4Bxl8J4SaPEPLq9IQ8g\", funnel: \"bQHJWKcyjiKjk4BHv91g\", step: \"2281a993-8a75-4b48-9912-571f29c99a74\", name: \"Sofa Set\" }",
"canceledAt": "2023-11-20T10:23:36.515Z",
"canceledBy": "qUuXUiB2AiA2DIthEicP",
"traceId": "302d2cf4-1ba0-4bf5-bc3b-f8fa76fda58a",
"createdBy": "user123"
}{
"statusCode": 400,
"message": "Bad Request"
}{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}{
"statusCode": 422,
"message": [
"Unprocessable Entity"
],
"error": "Unprocessable Entity"
}