Skip to main content

PaginatedResponseSubscription

items object[]required
  • Array [
  • amountinteger<int64>required
    billingPausedReasonstringnullable
    cancellationReasonstringnullable
    createdAtstring<date-time>nullable
    currencystringrequired
    currentCycleinteger<int32>required
    customerCodestringnullable
    customerIdstringrequired
    customerNamestringnullable
    endDatestring<date>nullable
    failedAttemptsinteger<int32>required
    intervalSubscriptionIntervalrequired

    Possible values: [DAILY, WEEKLY, MONTHLY, QUARTERLY, YEARLY]

    intervalCountinteger<int32>required
    items object[]
  • Array [
  • createdAtstring<date-time>nullable
    descriptionstringnullable
    idstringrequired
    metadata objectrequired
    property name*string
    priceIdstringrequired
    productIdstringrequired
    productNamestringnullable
    quantityinteger<int32>required
    subscriptionIdstringrequired
    unitAmountinteger<int64>required
  • ]
  • lastBillingDatestring<date>nullable
    lastBillingStatusstringnullable
    maxCyclesinteger<int32>nullable
    merchantIdstringrequired
    metadata object
    property name*string
    nextBillingDatestring<date>required
    planNamestringnullable
    purchaseOrderstringnullable
    savedPaymentMethodIdstringrequired
    scheduledResumeDatestring<date>nullable
    startDatestring<date>required
    statusSubscriptionStatusrequired

    Possible values: [TRIALING, ACTIVE, PAUSED, PAST_DUE, SUSPENDED, CANCELLING, CANCELLED, COMPLETED]

    subscriptionIdstringrequired
    taxAmountinteger<int64>nullable
    trialEndstring<date>nullable
    trialPeriodDaysinteger<int32>nullable
    trialStartstring<date>nullable
    updatedAtstring<date-time>nullable
  • ]
  • limitinteger<int32>required
    offsetinteger<int32>required
    totalinteger<int64>required
    PaginatedResponseSubscription
    {
    "items": [
    {
    "amount": 0,
    "billingPausedReason": "string",
    "cancellationReason": "string",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "currency": "string",
    "currentCycle": 0,
    "customerCode": "string",
    "customerId": "string",
    "customerName": "string",
    "endDate": "2024-07-29",
    "failedAttempts": 0,
    "interval": "DAILY",
    "intervalCount": 0,
    "items": [
    {
    "createdAt": "2024-07-29T15:51:28.071Z",
    "description": "string",
    "id": "string",
    "metadata": {},
    "priceId": "string",
    "productId": "string",
    "productName": "string",
    "quantity": 0,
    "subscriptionId": "string",
    "unitAmount": 0
    }
    ],
    "lastBillingDate": "2024-07-29",
    "lastBillingStatus": "string",
    "maxCycles": 0,
    "merchantId": "string",
    "metadata": {},
    "nextBillingDate": "2024-07-29",
    "planName": "string",
    "purchaseOrder": "string",
    "savedPaymentMethodId": "string",
    "scheduledResumeDate": "2024-07-29",
    "startDate": "2024-07-29",
    "status": "TRIALING",
    "subscriptionId": "string",
    "taxAmount": 0,
    "trialEnd": "2024-07-29",
    "trialPeriodDays": 0,
    "trialStart": "2024-07-29",
    "updatedAt": "2024-07-29T15:51:28.071Z"
    }
    ],
    "limit": 0,
    "offset": 0,
    "total": 0
    }