Sign in

v1

latestOpenAPI 3.0.02026-07-2475182625.5 KB
Subscriptions

List all subscription entries

Returns an array of order objects associated with the given subscription_id.

Each order object provides detailed information about transactions related to the subscription, including:

  • Original Order: The initial purchase associated with the subscription.
  • Rebills: Recurring transactions for subscription renewals.
  • Prorations and Edits: Transactions related to prorated adjustments or subscription changes.
get/subscriptions/{subscription_id}/entries

Path parameters

subscription_idstring required
Example:1abc2DE_FGhIjKLm3NoPQR

Unique identifier for the subscription.

Response

OK

idstring

Unique identifier for the subscription order.

beginEntryDatestring date

Date when the subscription entry begins.

beginPeriodDatestring date

Start date of the subscription period.

endPeriodDatestring date

End date of the subscription period.

Example response

[
  {
    "id": "QT3ktTTKT1-QIAZ8QAjxFQ",
    "beginEntryDate": "2025-01-15",
    "beginPeriodDate": "2025-01-01",
    "endPeriodDate": "2025-11-11",
    "order": {
      "order": "3KpFRioVTwepRifGJ-iqSg",
      "id": "3KpFRioVTwepRifGJ-iqSg",
      "reference": "NKO250115-3434-73110B",
      "ipAddress": "47.198.84.243",
      "completed": true,
      "changed": 1734563331876,
      "changedValue": 1734563331876,
      "changedInSeconds": 1734563331,
      "changedDisplay": "12/18/24",
      "changedDisplayISO8601": "2025-12-31",
      "changedDisplayEmailEnhancements": "Dec 31, 2025",
      "changedDisplayEmailEnhancementsWithTime": "Dec 31, 2025 11:08:51 PM",
      "language": "en",
      "currency": "USD",
      "payoutCurrency": "USD",
      "invoiceUrl": "https://example.test.onfastspring.com/popup-new-ui/account/order/ORDER123456/invoice/INVOICE123ABC456XYZ789",
      "siteId": "aBCDE12fGH",
      "account": "abCdE1FGH2Hij3KLMnOpqR",
      "total": 799.99,
      "totalDisplay": "$799.99",
      "totalInPayoutCurrency": 799.99,
      "totalInPayoutCurrencyDisplay": "$799.99",
      "taxDisplay": "$0.00",
      "taxInPayoutCurrencyDisplay": "$0.00",
      "subtotal": 799.99,
      "subtotalDisplay": "$799.99",
      "subtotalInPayoutCurrency": 799.99,
      "subtotalInPayoutCurrencyDisplay": "$799.99",
      "discountDisplay": "$0.00",
      "discountInPayoutCurrencyDisplay": "$0.00",
      "discountWithTaxDisplay": "$0.00",
      "discountWithTaxInPayoutCurrencyDisplay": "$0.00",
      "billDescriptor": "FS* fsprg.com",
      "payment": {
        "type": "test",
        "cardEnding": "4242"
      },
      "customer": {
        "first": "John",
        "last": "Doe",
        "email": "dummy.email@example.com",
        "phone": "1234567890"
      },
      "address": {
        "city": "Santa Barbara",
        "regionCode": "CA",
        "regionDisplay": "California",
        "region": "California",
        "postalCode": "93101",
        "country": "US",
        "display": "Santa Barbara, California, 93101, US"
      },
      "recipients": [
        {
          "recipient": {
            "first": "John",
            "last": "Doe",
            "email": "recipient.email@example.com",
            "phone": "1234567",
            "account": "dummy-account-id",
            "address": {
              "city": "Santa Barbara",
              "regionCode": "CA",
              "regionDisplay": "California",
              "region": "California",
              "postalCode": "93101",
              "country": "US",
              "display": "Santa Barbara, California, 93101, US"
            }
          }
        }
      ],
      "items": [
        {
          "product": "premium-tablet",
          "quantity": 1,
          "display": "Premium Tablet",
          "sku": "sku-67890",
          "shortDisplay": "Tablet",
          "subtotal": 799.99,
          "subtotalDisplay": "$799.99",
          "subtotalInPayoutCurrency": 799.99,
          "subtotalInPayoutCurrencyDisplay": "$799.99",
          "attributes": {
            "color": "Black",
            "storage": "128GB"
          },
          "discountDisplay": "$0.00",
          "discountInPayoutCurrencyDisplay": "$0.00",
          "isSubscription": true,
          "subscription": "aBCDE12fGH3iJkL4mNOpqr",
          "fulfillments": {
            "instructions": "<p>Expected delivery within 5 business days.</p>"
          },
          "proratedItemChangeAmountDisplay": "$0.00",
          "proratedItemChangeAmountInPayoutCurrencyDisplay": "$0.00",
          "proratedItemProratedChargeDisplay": "$0.00",
          "proratedItemProratedChargeInPayoutCurrencyDisplay": "$0.00",
          "proratedItemCreditAmountDisplay": "$0.00",
          "proratedItemCreditAmountInPayoutCurrencyDisplay": "$0.00",
          "proratedItemTaxAmountDisplay": "$0.00",
          "proratedItemTaxAmountInPayoutCurrencyDisplay": "$0.00",
          "proratedItemTotalDisplay": "$0.00",
          "proratedItemTotalInPayoutCurrencyDisplay": "$0.00"
        }
      ],
      "returns": [
        {
          "return": "AbC1D2eFGH34ijklmnopQrs",
          "amount": 799.99,
          "amountDisplay": "$799.99",
          "amountInPayoutCurrency": 799.99,
          "amountInPayoutCurrencyDisplay": "$799.99"
        }
      ]
    }
  }
]