Get Client Memberships

Request

Returns memberships found by client phone at the specified Location. Requires the authenticated Business User to have Loyalty access at that Location. chain_id can narrow results to a Chain. Each membership includes its number, type, creation time, and goods_transaction_id when linked to a goods transaction. created_date is membership creation time, not a guaranteed sale date. The type's cost is a current type price, not proof of the amount paid or the nominal price at purchase. Follow a nonzero goods_transaction_id through GET /storage_operations/goods_transactions/{location_id}/{transaction_id} to obtain its document_id, then use GET /transactions/{location_id} with document_id to inspect recorded payments. The response does not include a purchase receipt or a verified paid total.

Security

BearerPartnerUser

Query

location_idnumberrequired

Location ID

phonestringrequired

Customer phone number

chain_idinteger

Optional Chain ID used to narrow the membership lookup.

Acceptstringrequired

application/vnd.api.v2+json

Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/loyalty/abonements?location_id=0&phone=string&chain_id=0' \
  -H 'Accept: string' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

Bodyapplication/json

successboolean

Execution success status (true)

Example:true

dataArray of objects

Array of objects with data

Example:

[
  {
    "id": 659878,
    "number": 788376,
    "balance_string": "Surfing (x10)",
    "is_frozen": false,
    "freeze_period": 0,
    "period": 9999,
    "period_unit_id": 3,
    "status": { … },
    "balance_container": { … },
    "type": { … }
  }
]

metaobject

Metadata (contains the number of subscriptions found)

Example:

{
  "count": 1
}

Response

{
  "success": true,
  "data": [
    { … }
  ],
  "meta": {
    "count": 1
  }
}