Subrise Subscriptions Documentation for Shopify
Launch App
  • 🌎User Guides
    • πŸ‘‹Getting started with Subrise Subscriptions
    • 🎞️Dashboard Overview
      • πŸ“ŠReports
    • βš“Subscription Setup
      • πŸ‘ΎCreating your Subscription Plan
      • πŸ“™Managing your Subscription
    • πŸ› οΈSettings
      • Integrations
        • Attentive Integration
        • Shopify Flow
        • Klaviyo Integration
        • Zapier Integration
        • Mailchimp Integration
        • Google Sheets Integration
      • Notifications
      • Tags
      • Webhooks
      • Customer Portal
      • Support
    • ☸️Theme Extension
    • ❔FAQ
  • πŸ’»api-docs
    • πŸŒ„Getting Started
    • πŸ”‘Authentication
    • ♻️Subscriptions
      • 🟒GET
      • 🟠UPDATE
      • πŸ”΄DELETE
    • 🍘Products
    • πŸ“ƒSubscription Plans
    • ☺️Customers
    • πŸͺ΅Fields & Events
Powered by GitBook
On this page

Was this helpful?

  1. api-docs

Fields & Events

PreviousCustomers

Last updated 1 year ago

Was this helpful?

πŸ’»
πŸͺ΅

Fetch event logs

get

Retrieves a list of event logs, optionally filtered by subscription ID and supports pagination.

Query parameters
pageinteger Β· int32Optional

Page number of the event log pagination.

limitinteger Β· int32Optional

Number of event logs per page.

subscriptionIdstringOptional

Filter event logs by subscription ID.

Responses
200
A list of event logs.
application/json
500
Internal Server Error
application/json
get
GET /event-log/ HTTP/1.1
Host: localhost:3002
Accept: */*
{
  "logs": [
    {
      "subscriptionId": "text",
      "message": "text",
      "eventType": "Create",
      "userId": "text",
      "details": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "timestamp": "2025-05-09T10:00:56.490Z",
      "shop": "text"
    }
  ],
  "total": 1
}

Fetch field options

get

Retrieves a list of field options for various parameters used in the system.

Responses
200
A list of field options.
application/json
400
Bad Request - Errors in fetching field options.
application/json
get
GET /fields/ HTTP/1.1
Host: localhost:3002
Accept: */*
{
  "billingInterval": [
    "DAY",
    "MONTH",
    "WEEK",
    "YEAR"
  ],
  "billingAnchorType": [
    "WEEKDAY",
    "MONTHDAY",
    "YEARDAY"
  ],
  "deliveryInterval": [
    "DAY",
    "MONTH",
    "WEEK",
    "YEAR"
  ],
  "intent": [
    "FULFILLMENT_BEGIN"
  ],
  "preAnchorBehavior": [
    "ASAP",
    "NEXT"
  ],
  "deliveryAnchorType": [
    "WEEKDAY",
    "MONTHDAY",
    "YEARDAY"
  ],
  "pricingPolicyType": [
    "fixed",
    "recurring"
  ],
  "adjustmentType": [
    "FIXED_AMOUNT",
    "PERCENTAGE",
    "PRICE"
  ],
  "currencyCode": [
    "USD",
    "EUR",
    "GBP"
  ],
  "status": [
    "ACTIVE",
    "CANCELLED",
    "EXPIRED",
    "FAILED",
    "PAUSED"
  ]
}
  • GETFetch event logs
  • GETFetch field options