Skip to main content
Version: 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.

Request​

Version stringrequired

API Version

Available optionsv3
subscriptionId stringrequired

ID of the subscription that needs to be returned

altId stringrequired

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

altType stringrequired

AltType is the type of identifier.

Available optionslocation
application/json

Successful response

Schema
    _idstringrequired

    The unique identifier for the subscription.

    altTypeobjectrequired

    AltType is the type of identifier.

    altIdstringrequired

    AltId is the unique identifier eg: location id.

    contactIdstring

    Contact id corresponding to the subscription.

    contactSnapshotobject

    Contact details of the subscriber.

    couponobject

    Coupon details of the subscription.

    currencystring

    Currency in which subscription was made.

    amountnumber

    Subscription value.

    statusobject

    Subscription status.

    liveModeboolean

    Subscription is in live / test mode.

    entityTypestring

    Entity type of subscription (eg: order).

    entityIdstring

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

    entitySourceobject

    Entity source details for the subscription.

    subscriptionIdstring

    Subscription id for subscription.

    subscriptionSnapshotobject

    Snapshot of subscription.

    paymentProviderobject

    Payment provider details for the subscription.

    ipAddressstring

    Ip address from where subscription was initiated.

    createdAtstring<date-time>required

    The creation timestamp of the subscription.

    updatedAtstring<date-time>required

    The last update timestamp of the subscription.

    metaobject

    Meta details of the subscription.

    markAsTestboolean

    Is test subscription.

    scheduleobject

    Scedule details for the subscription.

    autoPaymentobject

    Auto payment details of the subscription.

    recurringProductobject

    Recurring product details of the subscription.

    canceledAtstring<date-time>

    Cancellation timestamp of the subscription.

    canceledBystring

    User id who cancelled the subscription.

    traceIdstring

    Trace id of the subscription.

    createdBystring

    User ID who created the subscription.