Get Subscription by ID

200 - Successful response

string

default:"64bf78af39118e4011926cba"

required

The unique identifier for the subscription.

object

default:"account"

required

AltType is the type of identifier.

string

default:"3SwdhCu3svxI8AKsPJt6"

required

AltId is the unique identifier eg: account id.

string

default:"XPLSw2SVagl12LMDeTmQ"

Contact id corresponding to the subscription.

object

Contact details of the subscriber.

object

Coupon details of the subscription.

string

default:"USD"

Currency in which subscription was made.

number

default:"100"

Subscription value.

object

default:"active"

Subscription status.

boolean

default:"false"

Subscription is in live / test mode.

string

default:"order"

Entity type of subscription (eg: order).

string

default:"62f4db0f3059ecee61379012"

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

object

Entity source details for the subscription.

string

default:"I-0UE609H8E43P"

Subscription id for subscription.

object

Snapshot of subscription.

object

Payment provider details for the subscription.

string

default:"103.100.16.82"

Ip address from where subscription was initiated.

string

default:"2023-11-20T10:23:36.515Z"

required

The creation timestamp of the subscription.

string

default:"2024-01-23T09:57:04.846Z"

required

The last update timestamp of the subscription.

object

Meta details of the subscription.

boolean

default:"false"

Is test subscription.

object

Scedule details for the subscription.

object

Auto payment details of the subscription.

object

Recurring product details of the subscription.

string

default:"2023-11-20T10:23:36.515Z"

Cancellation timestamp of the subscription.

string

default:"qUuXUiB2AiA2DIthEicP"

User id who cancelled the subscription.

string

default:"302d2cf4-1ba0-4bf5-bc3b-f8fa76fda58a"

Trace id of the subscription.

string

default:"user123"

User ID who created the subscription.

{
  "_id": "64bf78af39118e4011926cba",
  "altType": "account",
  "altId": "3SwdhCu3svxI8AKsPJt6",
  "contactId": "XPLSw2SVagl12LMDeTmQ",
  "contactSnapshot": "{ last_name: \"Mcclain\", type: \"lead\", first_name_lower_case: \"rogan\", email: \"anish+11@leadwaycrm.com\", last_name_lower_case: \"mcclain\", location_id: \"o6241QsiRwUIJHyjuhos\", company_name: \"Jordan and Cox Trading\"}",
  "coupon": "{ _id: \"6374c6926d119a393fe1e556\", usageCount: 5260, altId: \"jVFIxsMY19D94nOSIOEO\", altType: \"account\", 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",
  "createdAt": "2023-11-20T10:23:36.515Z",
  "updatedAt": "2024-01-23T09:57:04.846Z",
  "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"
}

400 - Subscription not found

{}

401 - Unauthorized

{}

422 - Unprocessable Entity

{}

Empezar

Scopes

Get Subscription by ID

Autorización

Path parameters

Query parameters

Respuestas

Ejemplo

​Autorización

​Path parameters

​Query parameters

​Respuestas

​Ejemplo

Autorización

Path parameters

Query parameters

Respuestas

Ejemplo