Skip to content

My Memberships

GET
/api/account/memberships
curl --request GET \
--url https://example.com/api/account/memberships \
--header 'Authorization: Bearer <token>'

Lists the customer’s memberships across all merchants, with each membership’s subscriptions.

OK

Media type application/json
Array<object>
object
memberId
string format: uuid
merchantId
string format: uuid
merchantName
string
nullable
status
string
Allowed values: Active Paused Cancelled
memberSince
string format: date-time
subscriptions
Array<object>
nullable
object
subscriptionId
string format: uuid
planName
string
nullable
price
number format: double
frequency
string
Allowed values: OneOff Daily Weekly Fortnightly Monthly Quarterly Yearly
status
string
Allowed values: Trial Active PastDue Paused Cancelled
nextBillingDate
string format: date-time
nullable
nextBillingAmount
number format: double
nullable
Example
[
{
"status": "Active",
"subscriptions": [
{
"frequency": "OneOff",
"status": "Trial"
}
]
}
]