Sign in
MyAccount

Get My Account Credits

Returns the unredeemed, unexpired credits available to the authenticated customer.

By default, only credits which haven't been redeemed and haven't expired are shown. Use the query parameters to include redeemed and/or expired credits. Revoked credits are never returned on this endpoint.

get/customers/my-account/credits

Query parameters

redeemedboolean

Whether to include redeemed credits

expiredboolean

Whether to include expired credits

Response

The customer's credits were successfully retrieved

Example response

{
  "data": [
    {
      "id": "000000-000000-000000-000000",
      "coupon_name": "Free 30 minute massage",
      "coupon_description": "Enjoy a free 30 minute massage as a thanks for being a loyal member",
      "multi_use": true,
      "customer_id": "000000-000000-000000-000000",
      "membership_id": "000000-000000-000000-000000",
      "revenue": 2495,
      "issued_at": "2021-01-01T00:00:00.000Z",
      "expires_at": "2021-01-01T00:00:00.000Z",
      "redeemed_at": "2021-01-01T00:00:00.000Z"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.