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.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your access token.
payments/ subscriptions. readonlyOAuthPrivate IntegrationSub-Account TokenRequest
Headers
API Version
v3Path Parameters
ID of the subscription that needs to be returned
6322e9c9e39fc14ab3ed7042Query Parameters
AltId is the unique identifier e.g: location id.
3SwdhCu3svxI8AKsPJt6AltType is the type of identifier.
locationlocationResponse
Successful response
The unique identifier for the subscription.
64bf78af39118e4011926cbaAltType is the type of identifier.
locationAltId is the unique identifier eg: location id.
3SwdhCu3svxI8AKsPJt6Contact id corresponding to the subscription.
XPLSw2SVagl12LMDeTmQContact details of the subscriber.
{ last_name: "Mcclain", type: "lead", first_name_lower_case: "rogan", email: "[email protected]", last_name_lower_case: "mcclain", location_id: "o6241QsiRwUIJHyjuhos", company_name: "Jordan and Cox Trading"}Coupon details of the subscription.
{ _id: "6374c6926d119a393fe1e556", usageCount: 5260, altId: "jVFIxsMY19D94nOSIOEO", altType: "location", name: "FREE-100%", code: "FREE100", discountType: "percentage", discountValue: 100 }Currency in which subscription was made.
USDSubscription value.
100Subscription status.
activeSubscription is in live / test mode.
falseEntity type of subscription (eg: order).
orderEntity id for the subscription. e.g: order id
62f4db0f3059ecee61379012Entity source details for the subscription.
Subscription id for subscription.
I-0UE609H8E43PSnapshot of subscription.
{ 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 }Payment provider details for the subscription.
{ type: "paypal", connectedAccount: { _id: "64410debdc8f3b0503523abb", merchantClientId: "AeXtjrxdgsJiCPwQt5jML5pH-0mwmLs-tH7ub4Uo3IrDKvRl34FvJy8niI6E1wmS_pryIRdNllyVl58b" } }Ip address from where subscription was initiated.
103.100.16.82The creation timestamp of the subscription.
2023-11-20T10:23:36.515ZThe last update timestamp of the subscription.
2024-01-23T09:57:04.846ZMeta details of the subscription.
{ collection: "transactionsv2", id: "6320652f0f664b6632006920" }Is test subscription.
falseScedule details for the subscription.
Auto payment details of the subscription.
{ customerId: "908879612", paymentMethodId: "908646635" }Recurring product details of the subscription.
{ locationId: "Z4Bxl8J4SaPEPLq9IQ8g", funnel: "bQHJWKcyjiKjk4BHv91g", step: "2281a993-8a75-4b48-9912-571f29c99a74", name: "Sofa Set" }Cancellation timestamp of the subscription.
2023-11-20T10:23:36.515ZUser id who cancelled the subscription.
qUuXUiB2AiA2DIthEicPTrace id of the subscription.
302d2cf4-1ba0-4bf5-bc3b-f8fa76fda58aUser ID who created the subscription.
user123