Skip to content
EntitlerDocs

GET/v1/customers/{external_id}/subscription-events

List a customer's subscription events

Lists the customer's subscription events, newest first, a page at a time. Needs customers:read.

curl 'https://api.entitler.co/v1/customers/ada/subscription-events' \
  -H "Authorization: Bearer $ENTITLER_KEY"

Credentials

Send any one of these:

  • Bearer token

Path parameters

NameTypeDescription
external_idrequiredstringThe customer's external ID, or me for the customer a customer token or identity token names.

Query parameters

NameTypeDescription
target.team_idstring
target.project_idstring
target.environment_idstring
page_sizeinteger (int64)
page_tokenstring

Responses

200The ListSubscriptionEventsResponse message.

ListSubscriptionEventsResponse

  • eventsarray of SubscriptionEventrequired
    • actorcommon.Actor
      • idstringrequired
      • typecommon.ActorTyperequired

        One of ACTOR_TYPE_UNSPECIFIED, ACTOR_TYPE_USER, ACTOR_TYPE_KEY, ACTOR_TYPE_SYSTEM.

    • amountAmount
      • amountintegerrequired

        at least 0; at most 18446744073709552000

      • currencystringrequired
      • displaystringrequired
    • atintegerrequired

      at least 0; at most 18446744073709552000

    • chargeIdsarray of stringrequired
    • cohortIdstring
    • collectionMethodCollectionMethodrequired

      One of COLLECTION_METHOD_UNSPECIFIED, COLLECTION_METHOD_PAYMENT_PROVIDER, COLLECTION_METHOD_MANUAL, COLLECTION_METHOD_COMPLIMENTARY.

    • discountEndReasonDiscountEndReasonrequired

      One of DISCOUNT_END_REASON_UNSPECIFIED, DISCOUNT_END_REASON_PERIODS_USED, DISCOUNT_END_REASON_END_DATE_REACHED, DISCOUNT_END_REASON_PLAN_CHANGED, DISCOUNT_END_REASON_PROVIDER, DISCOUNT_END_REASON_PAYER_ENDED, DISCOUNT_END_REASON_PAID_OFF, DISCOUNT_END_REASON_LEFT_SEGMENT, DISCOUNT_END_REASON_OFFER_ENDED.

    • discountSourceDiscountSourcerequired

      One of DISCOUNT_SOURCE_UNSPECIFIED, DISCOUNT_SOURCE_BUSINESS, DISCOUNT_SOURCE_CUSTOMER, DISCOUNT_SOURCE_CODE, DISCOUNT_SOURCE_SEGMENT, DISCOUNT_SOURCE_REFERRAL.

    • draftIdstring
    • dueAtinteger

      at least 0; at most 18446744073709552000

    • earlybooleanrequired
    • effectiveAtintegerrequired

      at least 0; at most 18446744073709552000

    • fromPlanIdstring
    • fromQuantityinteger (int64)

      at least 0; at most 4294967295

    • fromVersionNumberinteger

      at least 0; at most 18446744073709552000

    • grantIdstring
    • idstringrequired
    • keepsBillingbooleanrequired
    • modeModerequired

      One of MODE_UNSPECIFIED, MODE_LIVE, MODE_TEST.

    • offerCodestring
    • offerIdstring
    • payerEndReasonPayerEndReasonrequired

      One of PAYER_END_REASON_UNSPECIFIED, PAYER_END_REASON_ENDED, PAYER_END_REASON_UNTIL_REACHED, PAYER_END_REASON_PAYER_ERASED, PAYER_END_REASON_PAYER_DELETED.

    • payerIdstring
    • periodIdstring
    • periodsinteger (int64)

      at least 0; at most 4294967295

    • planIdstring
    • productIdstring
    • quantityinteger (int64)

      at least 0; at most 4294967295

    • reasonstring
    • referralIdstring
    • refundsRefunds
      • refundsarray of Refundrequired
        • amountAmount
          • amountintegerrequired

            at least 0; at most 18446744073709552000

          • currencystringrequired
          • displaystringrequired
        • chargeIdstring
        • paidAtinteger

          at least 0; at most 18446744073709552000

      • totalAmount
        • amountintegerrequired

          at least 0; at most 18446744073709552000

        • currencystringrequired
        • displaystringrequired
    • releaseChannelIdstring
    • releaseIdstring
    • reversalScopeReversalScoperequired

      One of REVERSAL_SCOPE_UNSPECIFIED, REVERSAL_SCOPE_SUBSCRIPTION, REVERSAL_SCOPE_CUSTOMER, REVERSAL_SCOPE_CUSTOMER_BLOCKED.

    • rolloutIdstring
    • topUpPurchaseIdstring
    • topUpsarray of TopUpAmountrequired
      • amountintegerrequired

        at least 0; at most 18446744073709552000

      • featureKeystringrequired
    • trialOutcomeTrialOutcomerequired

      One of TRIAL_OUTCOME_UNSPECIFIED, TRIAL_OUTCOME_CONVERTED, TRIAL_OUTCOME_FELL_BACK, TRIAL_OUTCOME_ENDED.

    • typeSubscriptionEventTyperequired

      One of SUBSCRIPTION_EVENT_TYPE_UNSPECIFIED, SUBSCRIPTION_EVENT_TYPE_SUBSCRIBED, SUBSCRIPTION_EVENT_TYPE_PLAN_CHANGED, SUBSCRIPTION_EVENT_TYPE_PLAN_CHANGE_SCHEDULED, SUBSCRIPTION_EVENT_TYPE_CANCELLED, SUBSCRIPTION_EVENT_TYPE_CANCELLATION_SCHEDULED, SUBSCRIPTION_EVENT_TYPE_SCHEDULED_CHANGE_CANCELLED, SUBSCRIPTION_EVENT_TYPE_PERIOD_CHANGED, SUBSCRIPTION_EVENT_TYPE_END_DATE_SET, SUBSCRIPTION_EVENT_TYPE_VERSION_CHANGED, SUBSCRIPTION_EVENT_TYPE_VERSION_CHANGE_SCHEDULED, SUBSCRIPTION_EVENT_TYPE_RENEWED, SUBSCRIPTION_EVENT_TYPE_ENDED, SUBSCRIPTION_EVENT_TYPE_ADD_ON_ADDED, SUBSCRIPTION_EVENT_TYPE_ADD_ON_QUANTITY_SET, SUBSCRIPTION_EVENT_TYPE_ADD_ON_REMOVED, SUBSCRIPTION_EVENT_TYPE_ADD_ON_CHANGED, SUBSCRIPTION_EVENT_TYPE_ADD_ON_CHANGE_SCHEDULED, SUBSCRIPTION_EVENT_TYPE_ADD_ON_SCHEDULED_CHANGE_CANCELLED, SUBSCRIPTION_EVENT_TYPE_GRANT_CREATED, SUBSCRIPTION_EVENT_TYPE_GRANT_REVOKED, SUBSCRIPTION_EVENT_TYPE_RELEASE_CHANNEL_ASSIGNED, SUBSCRIPTION_EVENT_TYPE_COLLECTION_METHOD_SET, SUBSCRIPTION_EVENT_TYPE_AWAITING_PAYMENT, SUBSCRIPTION_EVENT_TYPE_PAYMENT_MISSED, SUBSCRIPTION_EVENT_TYPE_PAYMENT_RECORDED, SUBSCRIPTION_EVENT_TYPE_PAYMENT_REVERSED, SUBSCRIPTION_EVENT_TYPE_VERSION_CHANGE_ACCEPTED, SUBSCRIPTION_EVENT_TYPE_VERSION_CHANGE_NOT_ACCEPTED, SUBSCRIPTION_EVENT_TYPE_DISCOUNT_ADDED, SUBSCRIPTION_EVENT_TYPE_DISCOUNT_ENDED, SUBSCRIPTION_EVENT_TYPE_DISCOUNT_REMOVED, SUBSCRIPTION_EVENT_TYPE_DISCOUNT_APPLIED, SUBSCRIPTION_EVENT_TYPE_CHARGE_CREATED, SUBSCRIPTION_EVENT_TYPE_CHARGE_PAID, SUBSCRIPTION_EVENT_TYPE_CHARGE_REVERSED, SUBSCRIPTION_EVENT_TYPE_RENEWED_NOW, SUBSCRIPTION_EVENT_TYPE_PAYER_ADDED, SUBSCRIPTION_EVENT_TYPE_PAYER_ENDED, SUBSCRIPTION_EVENT_TYPE_PAUSED, SUBSCRIPTION_EVENT_TYPE_RESUMED, SUBSCRIPTION_EVENT_TYPE_CANCELLED_IN_COOLING_OFF, SUBSCRIPTION_EVENT_TYPE_SUSPENDED, SUBSCRIPTION_EVENT_TYPE_SUSPENSION_LIFTED, SUBSCRIPTION_EVENT_TYPE_INCOMPLETE, SUBSCRIPTION_EVENT_TYPE_INCOMPLETE_EXPIRED, SUBSCRIPTION_EVENT_TYPE_PAID_OFF, SUBSCRIPTION_EVENT_TYPE_PAYER_SHARE_APPLIED, SUBSCRIPTION_EVENT_TYPE_VOUCHER_REDEEMED, SUBSCRIPTION_EVENT_TYPE_TRIAL_STARTED, SUBSCRIPTION_EVENT_TYPE_TRIAL_CONVERTED, SUBSCRIPTION_EVENT_TYPE_TRIAL_ENDED, SUBSCRIPTION_EVENT_TYPE_ADD_ON_QUANTITY_SCHEDULED, SUBSCRIPTION_EVENT_TYPE_VOUCHER_TAKEN_BACK, SUBSCRIPTION_EVENT_TYPE_WAITING_CREDITED, SUBSCRIPTION_EVENT_TYPE_WAITING_CREDIT_REMOVED, SUBSCRIPTION_EVENT_TYPE_GIFT_PAID, SUBSCRIPTION_EVENT_TYPE_TOP_UP_BOUGHT, SUBSCRIPTION_EVENT_TYPE_TOP_UP_REVERSED.

    • versionNumberinteger

      at least 0; at most 18446744073709552000

    • voucherIdstring
    • waitingCreditIdstring
  • nextPageTokenstring

ErrorA refusal, with the HTTP status of its gRPC code.

Error

  • errorobjectrequired
    • codestringrequired
    • parametersobjectrequired

      Each value: string

    • reasonstringor nullrequired