List Subscriptions

The “List Subscriptions” API allows to retrieve a paginated list of subscriptions. Customize your results by filtering subscriptions based on name, alt type, subscription status, payment mode, date range, type of source, contact, subscription id, entity id, contact or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve subscription information.

GET https://services.leadconnectorhq.com/payments/subscriptions

Autorización

string

required

Bearer token generado desde el portal Leadway. Ver Autenticación.

string

default:"2021-07-28"

required

Versión de la API.

Query parameters

string

default:"3SwdhCu3svxI8AKsPJt6"

required

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

string

default:"account"

required

AltType is the type of identifier.

string

default:"61dd0fe9c077f73e67f78803"

Entity id for filtering of subscriptions.

string

default:"live"

Mode of payment.

string

default:"2024-02-01"

Starting interval of subscriptions.

string

default:"2024-02-13"

Closing interval of subscriptions.

string

default:"funnel"

Source of the subscriptions.

string

default:"Awesome subscription"

The name of the subscription for searching.

string

default:"AmuzcoPBpgKeccNsFlib"

Contact ID for the subscription

string

default:"64bf78af39118e4011926cba"

Subscription id for filtering of subscriptions.

number

default:"20"

The maximum number of items to be included in a single page of results

number

default:"0"

The starting index of the page, indicating the position from which the results should be retrieved.

boolean

default:"true"

Get the total payments collected for the subscription.

Respuestas

200 - Successful response

object[]

required

An array of subscriptions

Show cada item

string

default:"64bf78af39118e4011926cba"

required

The unique identifier for the subscription.

string

default:"3SwdhCu3svxI8AKsPJt6"

required

AltId is the unique identifier eg: account id.

string

default:"account"

required

AltType is the type of identifier. Posibles valores: ‘account’

string

default:"XPLSw2SVagl12LMDeTmQ"

Contact id corresponding to the subscription.

string

default:"James Bond"

Contact name corresponding to the subscription.

string

default:"james.bond@leadwaycrm.com"

Contact email corresponding to the subscription.

string

default:"USD"

Currency in which subscription occurred.

number

default:"100"

Subscription value.

object

default:"active"

required

The status of the subscription (e.g., succeeded).

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

string

default:"funnel"

required

Entity source type of subscription (eg: funnel).

string

default:"Attribution Funnel"

Entity source name for the subscription.

string

default:"bevrkPbLaDNXFaqfLKMm"

Entity source id for the subscription.

object

Meta content for the entity source of subscription.

string

default:"I-0UE609H8E43P"

Subscription id for subscription.

object

Snapshot of subscription.

string

default:"stripe"

Payment provider for subscription.

string

Payment provider connected account id for 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:"2023-11-20T10:23:36.515Z"

required

The update timestamp of the subscription.

string

default:"user123"

User ID who created the subscription.

number

required

total subscriptions count

{
  "data": [
    {
      "_id": "64bf78af39118e4011926cba",
      "altId": "3SwdhCu3svxI8AKsPJt6",
      "altType": "account",
      "contactId": "XPLSw2SVagl12LMDeTmQ",
      "contactName": "James Bond",
      "contactEmail": "james.bond@leadwaycrm.com",
      "currency": "USD",
      "amount": "100",
      "status": "active",
      "liveMode": "false",
      "entityType": "order",
      "entityId": "62f4db0f3059ecee61379012",
      "entitySourceType": "funnel",
      "entitySourceName": "Attribution Funnel",
      "entitySourceId": "bevrkPbLaDNXFaqfLKMm",
      "entitySourceMeta": "{ domain: \"app.leadwaycrm.com\", pageId:  \"sxC4lNhFIavEnLZh5KhC\", pageUrl:  \"/v2/preview/sxC4lNhFIavEnLZh5KhC\", stepId: \"7d303d1f-cb85-403d-b548-bf01de5c7bb0\" }",
      "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 }",
      "paymentProviderType": "stripe",
      "paymentProviderConnectedAccount": "ATn0CqrzrWS5ak185Bsb1xCpyzBDOZ8WdRxyFotppLYePTDhiuQ49H5QXO_L-4HKk1GBn7f9_QhbNK2s",
      "ipAddress": "103.100.16.82",
      "createdAt": "2023-11-20T10:23:36.515Z",
      "updatedAt": "2023-11-20T10:23:36.515Z",
      "createdBy": "user123"
    }
  ],
  "totalCount": 0
}

400 - Bad Request

{}

401 - Unauthorized

{}

422 - Unprocessable Entity

{}

Ejemplo

curl -X GET 'https://services.leadconnectorhq.com/payments/subscriptions' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28'

const response = await fetch('https://services.leadconnectorhq.com/payments/subscriptions', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
  },
});
const data = await response.json();

import os, requests
response = requests.request(
    'GET',
    'https://services.leadconnectorhq.com/payments/subscriptions',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
    },
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/payments/subscriptions');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
        'Version: 2021-07-28',
    ],
]);
$data = json_decode(curl_exec($ch), true);

Empezar

Scopes

Autorización

Query parameters

Respuestas

Ejemplo

​Autorización

​Query parameters

​Respuestas

​Ejemplo

Autorización

Query parameters

Respuestas

Ejemplo