Skip to main content
SubscriptionsVersion: v3

Get Subscription by ID

GET/payments/subscriptions/{subscriptionId}

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

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:payments/subscriptions.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Path Parameters

subscriptionIdstringrequired

ID of the subscription that needs to be returned

Example:6322e9c9e39fc14ab3ed7042

Query Parameters

altIdstringrequired

AltId is the unique identifier e.g: location id.

Example:3SwdhCu3svxI8AKsPJt6
altTypestringrequired

AltType is the type of identifier.

Available optionslocation
Example:location

Response

Successful response

_idstringrequired

The unique identifier for the subscription.

Example:64bf78af39118e4011926cba
altTypeobjectrequired

AltType is the type of identifier.

Example:location
altIdstringrequired

AltId is the unique identifier eg: location id.

Example:3SwdhCu3svxI8AKsPJt6
contactIdstring

Contact id corresponding to the subscription.

Example:XPLSw2SVagl12LMDeTmQ
contactSnapshotobject

Contact details of the subscriber.

Example:{ 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"}
couponobject

Coupon details of the subscription.

Example:{ _id: "6374c6926d119a393fe1e556", usageCount: 5260, altId: "jVFIxsMY19D94nOSIOEO", altType: "location", name: "FREE-100%", code: "FREE100", discountType: "percentage", discountValue: 100 }
currencystring

Currency in which subscription was made.

Example:USD
amountnumber

Subscription value.

Example:100
statusobject

Subscription status.

Example:active
liveModeboolean

Subscription is in live / test mode.

Example:false
entityTypestring

Entity type of subscription (eg: order).

Example:order
entityIdstring

Entity id for the subscription. e.g: order id

Example:62f4db0f3059ecee61379012
entitySourceobject

Entity source details for the subscription.

subscriptionIdstring

Subscription id for subscription.

Example:I-0UE609H8E43P
subscriptionSnapshotobject

Snapshot of subscription.

Example:{ 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 }
paymentProviderobject

Payment provider details for the subscription.

Example:{ type: "paypal", connectedAccount: { _id: "64410debdc8f3b0503523abb", merchantClientId: "AeXtjrxdgsJiCPwQt5jML5pH-0mwmLs-tH7ub4Uo3IrDKvRl34FvJy8niI6E1wmS_pryIRdNllyVl58b" } }
ipAddressstring

Ip address from where subscription was initiated.

Example:103.100.16.82
createdAtstring<date-time>required

The creation timestamp of the subscription.

Example:2023-11-20T10:23:36.515Z
updatedAtstring<date-time>required

The last update timestamp of the subscription.

Example:2024-01-23T09:57:04.846Z
metaobject

Meta details of the subscription.

Example:{ collection: "transactionsv2", id: "6320652f0f664b6632006920" }
markAsTestboolean

Is test subscription.

Example:false
scheduleobject

Scedule details for the subscription.

autoPaymentobject

Auto payment details of the subscription.

Example:{ customerId: "908879612", paymentMethodId: "908646635" }
recurringProductobject

Recurring product details of the subscription.

Example:{ locationId: "Z4Bxl8J4SaPEPLq9IQ8g", funnel: "bQHJWKcyjiKjk4BHv91g", step: "2281a993-8a75-4b48-9912-571f29c99a74", name: "Sofa Set" }
canceledAtstring<date-time>

Cancellation timestamp of the subscription.

Example:2023-11-20T10:23:36.515Z
canceledBystring

User id who cancelled the subscription.

Example:qUuXUiB2AiA2DIthEicP
traceIdstring

Trace id of the subscription.

Example:302d2cf4-1ba0-4bf5-bc3b-f8fa76fda58a
createdBystring

User ID who created the subscription.

Example:user123