Private API Reference

Stripe Customers

The authenticated end user on whose behalf your application is authorized, expressed in the Financial Data Exchange (FDX) customer shape. This is the response of the FDX getCustomerInfo operation. The customerId matches the sub returned by the user-info endpoint.

The Stripe Customer object

{
  "accounts": [
    {
      "accountId": "account_in71c4amph0vgo2qllky",
      "links": [
        {
          "href": "https://api.increase.com/fdx/stripe/accounts/account_in71c4amph0vgo2qllky",
          "rel": "self"
        }
      ],
      "relationship": "PRIMARY"
    }
  ],
  "customerId": "role_9xbk70891hiu2yj8kfof",
  "emails": [
    "support@increase.com"
  ]
}

Attributes

accounts

array

The accounts the customer has authorized your application to access.

customerId

string

Long-term persistent identity of the customer. Matches the sub returned by the user-info endpoint.

emails

array of strings

Email addresses associated with the customer.

Retrieve the current Stripe customer

Retrieve information about the authenticated end user on whose behalf your application is authorized, in the Financial Data Exchange (FDX) customer shape. The response carries the customer’s stable identifier (matching the sub from the user-info endpoint), email, and the accounts the customer has authorized along with their relationship to each.

curl \
  --url "${INCREASE_URL}/fdx/stripe/customers/current" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"