---
title: "List the Braintree subscriptions of a user"
method: GET
path: "/blaize/payment/braintree/subscriptions"
tags: ["Braintree Payments"]
---

# List the Braintree subscriptions of a user

`GET /blaize/payment/braintree/subscriptions`

## Request

- Base URL: `https://demo-site`
- URL: `https://demo-site/blaize/payment/braintree/subscriptions`
- Auth: one of:
  - API key in cookie `blaize_session`
  - API key in query parameter `jwt`
  - API key in header `x-blaize-jwt`
  - API key in header `x-zephr-jwt`
  - HTTP bearer
  - API key in cookie `blaize_jwt`

Lists all Braintree subscriptions for the logged-in user.

## Headers

- `cookie` string

## Response `200`

OK

- object
  - `managed-by` string, required: The name of payment provider capitalised.
  - `ends` string, date-time: ISO-8601 formatted time at which the subscription was canceled. This field will be omitted if the subscription is not canceled.
  - `external-id` string, required: The ID for this subscription in Braintree.
  - `next-billing-time` string, date-time, required: ISO-8601 formatted time at which the subscription will next be billed.
  - `blaize-product` BraintreeSubscriptionProduct, required
    - `tenantId` string: Zephr tenant ID and site slug
    - `subTenantId` string: Zephr subtenant ID and site slug
    - `id` string: Zephr product ID
    - `label` string: Zephr product label
    - `description` string: Description of Zephr product
    - `entitlement` object
      - `id` string: Zephr product entitlement ID
      - `type` string: Zephr product entitlement type
    - `mapping` object
      - `recurring` object
        - `plans` object[]: Recurring plans assigned to this product
          - `id` string
          - `label` string
          - `archived` boolean
          - `billingCycles` number: Number of billing cycles for this plan, `null` if none defined
          - `paymentProvider` string: Payment provider name in lowercase
        - `multiPhasedPlans` object[]: Multi-phased plans are not supported in Braintree, this will be `null`
      - `oneOff` object
        - `plans` object[]
          - `id` string
          - `label` string: always `null`
          - `archived` boolean
          - `billingCycles` number: always `null`
          - `paymentProvider` string: Payment provider name in lowercase
          - `accessDuration` object
            - `duration` number: Number of months this plan provides
            - `unit` string: always 'MONTHS'
      - `jwt` object
        - `claim_value` string
    - `sharingLimit` number: The number of users this product can be shared with. Users can share the product multiple times by canceling previous shares. A value of `0` indicates that the product is not shareable.
  - `transaction-history` object[], required
    - `time` string, date-time: ISO-8601 formatted time at which the transaction was made.
    - `currency` string
    - `cents` number
    - `cycle` string
    - `cycleCount` number
    - `currencyCode` string: ISO 4217 currency code for this currency.
    - `human-readable-amount` string
  - `subscription-state` 'Active' | 'Canceled' | 'Expired' | 'Past Due' | 'Pending' | 'Unrecognized', required: The subscription state, as acquired from Braintree.
  - `paid_through_date` string, date-time: ISO-8601 formatted time up to which the subscription has been paid for. This will be `null` if the subscription has not yet been paid for.
  - `plan_id` string, required: The Braintree plan ID
  - `plan_name` string, required: The Braintree plan name
  - `billing_frequency_unit` 'MONTH', required: The time unit of the billing frequency. Braintree only supports MONTH.
  - `billing_frequency` number, required: The frequency at which the subscription is billed, in the units specified by billing_frequency_unit.
  - `currency_code` string, required: The currency of the subscription price.
  - `pre_discount_price` number, required: The subscription price before any discounts are applied.
  - `multiphase_plan` boolean, required: Always `false`, as Braintree does not support multi-phased plans.
  - `discounts_applied` boolean, required: If the subscription has any applied discounts.

## Other responses

- `401`: Unauthorized
- `404`: Not Found

---

[API](https://skmtc.dev/zuora/apis/zuora-2.md) - [All operations](https://skmtc.dev/zuora/apis/zuora-2/llms.txt) - [OpenAPI document](https://skmtc.dev/zuora/apis/zuora-2/revisions/678190d04c40?raw)