v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Get Membership Tries Report

This API retrieves a flat-file report of membership recurring invoice collection tries with detailed try status, payment information, and decline details. Supports filtering by centers, date ranges, invoice statuses, try statuses, recurring statuses, payment types, days pending buckets, and grouping columns. Results are paginated.

post/{api_url}/v1/reports/membership_tries/flat_file?page={page}&size={size}

Query parameters

pageinteger

Page number. Use -1 to retrieve all records. Must be -1 or greater than 0.

sizeinteger

Number of records per page. Must be greater than 0.

Response

200

OR
object required

Example response

{
  "membership_tries": [
    {
      "center_name": "Downtown Spa",
      "invoice_number": "INV-2026-00001",
      "try_number": "1st",
      "try_date": "2026-01-15T10:30:00",
      "try_status": "Success",
      "current_invoice_status": "Collected",
      "guest_name": "John Doe",
      "guest_gender": "Male",
      "membership_name": "Gold Membership",
      "primary_payment_type": "Credit Card",
      "primary_payment_method": "VISA ending 4242",
      "membership_status": "Active",
      "current_recurring_status": "Active",
      "original_scheduled_date": "2026-01-10T00:00:00",
      "amount_to_be_paid": 150,
      "payment_method_used": "VISA ending 4242",
      "payment_method_type": "Primary",
      "try_method": "Automatic",
      "collection_type": "Membership invoice",
      "invoice_type": "Collection invoice",
      "what_payment_method_used": "Credit Card",
      "decline_fee_charged": "No",
      "remaining_retry_attempts": "3",
      "days_pending_bucket": "Collected",
      "guest_code": "GC-10001",
      "member_code": "MC-20001",
      "invoice_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "guest_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "center_id": "c3d4e5f6-a7b8-9012-cdef-123456789012"
    }
  ],
  "total": {
    "amount_to_be_paid": 150
  },
  "pagination": {
    "page": 1,
    "size": 10,
    "total": 1
  }
}