List Subscription Enrollments

List all previously created Subscription Enrollments.

Copy
Copied
curl https://finix.sandbox-payments-api.com/subscription/subscription_enrollments  \
    -H "Content-Type: application/vnd.json+api" \
    -u  UStxEci4vXxGDWLQhNvao7YY:25038781-2369-4113-8187-34780e91052e

Example Response:

Copy
Copied
{
  "_embedded" : {
    "subscription_enrollments" : [ {
      "id" : "SUBENROLLMENT_uPamF4YuEyzVTT42hwYgBV",
      "created_at" : "2022-01-27T07:44:09.08Z",
      "updated_at" : "2022-01-27T07:44:09.08Z",
      "created_by" : "UStxEci4vXxGDWLQhNvao7YY",
      "ended_at" : null,
      "merchant" : "MUucec6fHeaWo3VHYoSkUySM",
      "nickname" : "Security Fee",
      "started_at" : "2022-11-11T16:50:59.89Z",
      "subscription_schedule" : "SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ",
      "tags" : {
        "enrollment_info" : "Security Fee Enrollment"
      },
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_uPamF4YuEyzVTT42hwYgBV"
        },
        "merchant" : {
          "href" : "https://finix.sandbox-payments-api.com/merchants/MUucec6fHeaWo3VHYoSkUySM"
        },
        "schedule" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_uxsUJrgbQZEXsWm9toq6gZ/subscription_amounts"
        }
      }
    }, {
      "id" : "SUBENROLLMENT_mdekY4w6XCv7gNzAHQxJ3e",
      "created_at" : "2022-01-26T23:35:26.43Z",
      "updated_at" : "2022-01-26T23:35:26.43Z",
      "created_by" : "UStxEci4vXxGDWLQhNvao7YY",
      "ended_at" : null,
      "merchant" : "MUhSozGFhgbR6gGjLwbysRaR",
      "nickname" : "Security Fee",
      "started_at" : "2022-11-11T16:50:59.89Z",
      "subscription_schedule" : "SUBSCHEDULE_kUvyQgikZkbg6p2vd6U9of",
      "tags" : {
        "enrollment_info" : "Security Fee Enrollment"
      },
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_mdekY4w6XCv7gNzAHQxJ3e"
        },
        "merchant" : {
          "href" : "https://finix.sandbox-payments-api.com/merchants/MUhSozGFhgbR6gGjLwbysRaR"
        },
        "schedule" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_kUvyQgikZkbg6p2vd6U9of"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_kUvyQgikZkbg6p2vd6U9of/subscription_amounts"
        }
      }
    }, {
      "id" : "SUBENROLLMENT_bBhQSipvHBqf75VY7pqwta",
      "created_at" : "2022-01-13T00:04:11.16Z",
      "updated_at" : "2022-01-13T00:04:11.16Z",
      "created_by" : "UStxEci4vXxGDWLQhNvao7YY",
      "ended_at" : null,
      "merchant" : "MUwLX5PeoSp8worY84tX2MVq",
      "nickname" : "Security Fee",
      "started_at" : "2022-11-11T16:50:59.89Z",
      "subscription_schedule" : "SUBSCHEDULE_bkXRUUeuN8AfR3RVNUn4vS",
      "tags" : {
        "enrollment_info" : "Security Fee Enrollment"
      },
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_bBhQSipvHBqf75VY7pqwta"
        },
        "merchant" : {
          "href" : "https://finix.sandbox-payments-api.com/merchants/MUwLX5PeoSp8worY84tX2MVq"
        },
        "schedule" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_bkXRUUeuN8AfR3RVNUn4vS"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_bkXRUUeuN8AfR3RVNUn4vS/subscription_amounts"
        }
      }
    }, {
      "id" : "SUBENROLLMENT_qvmKt49RiEYP4aUFbQUyAe",
      "created_at" : "2022-01-12T22:41:26.02Z",
      "updated_at" : "2022-01-12T22:41:26.02Z",
      "created_by" : "UStxEci4vXxGDWLQhNvao7YY",
      "ended_at" : null,
      "merchant" : "MUjNTohihEUuQMfPDMKULfeY",
      "nickname" : "Security Fee",
      "started_at" : "2022-11-11T16:50:59.89Z",
      "subscription_schedule" : "SUBSCHEDULE_qeY8pHJiCo7e2fqmHyqKDV",
      "tags" : {
        "enrollment_info" : "Security Fee Enrollment"
      },
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_qvmKt49RiEYP4aUFbQUyAe"
        },
        "merchant" : {
          "href" : "https://finix.sandbox-payments-api.com/merchants/MUjNTohihEUuQMfPDMKULfeY"
        },
        "schedule" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_qeY8pHJiCo7e2fqmHyqKDV"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_qeY8pHJiCo7e2fqmHyqKDV/subscription_amounts"
        }
      }
    }, {
      "id" : "SUBENROLLMENT_fhXN1GwicvEbCYRzbH3KXR",
      "created_at" : "2022-01-08T00:53:53.98Z",
      "updated_at" : "2022-01-08T00:53:53.98Z",
      "created_by" : "UStxEci4vXxGDWLQhNvao7YY",
      "ended_at" : null,
      "merchant" : "MUuJkmQBCVPh9riNLVgEbPxf",
      "nickname" : "Security Fee",
      "started_at" : "2022-11-11T16:50:59.89Z",
      "subscription_schedule" : "SUBSCHEDULE_f2CiEiZTqGju1TsCn1cesT",
      "tags" : {
        "enrollment_info" : "Security Fee Enrollment"
      },
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_fhXN1GwicvEbCYRzbH3KXR"
        },
        "merchant" : {
          "href" : "https://finix.sandbox-payments-api.com/merchants/MUuJkmQBCVPh9riNLVgEbPxf"
        },
        "schedule" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_f2CiEiZTqGju1TsCn1cesT"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_f2CiEiZTqGju1TsCn1cesT/subscription_amounts"
        }
      }
    }, {
      "id" : "SUBENROLLMENT_7PH3MEqYHbysoFf9vifPm7",
      "created_at" : "2022-01-07T18:39:58.66Z",
      "updated_at" : "2022-01-07T18:39:58.66Z",
      "created_by" : "UStxEci4vXxGDWLQhNvao7YY",
      "ended_at" : null,
      "merchant" : "MUwKiuHLp9TJ1WABMfcEmvpW",
      "nickname" : "Security Fee",
      "started_at" : "2022-11-11T16:50:59.89Z",
      "subscription_schedule" : "SUBSCHEDULE_7yDCdvjYL4gbKYmLxAUEHE",
      "tags" : {
        "enrollment_info" : "Security Fee Enrollment"
      },
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_7PH3MEqYHbysoFf9vifPm7"
        },
        "merchant" : {
          "href" : "https://finix.sandbox-payments-api.com/merchants/MUwKiuHLp9TJ1WABMfcEmvpW"
        },
        "schedule" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_7yDCdvjYL4gbKYmLxAUEHE"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_7yDCdvjYL4gbKYmLxAUEHE/subscription_amounts"
        }
      }
    }, {
      "id" : "SUBENROLLMENT_5SJ9GLz8rAn2aeFGnqtC6v",
      "created_at" : "2022-01-06T02:20:02.30Z",
      "updated_at" : "2022-01-06T02:20:02.30Z",
      "created_by" : "UStxEci4vXxGDWLQhNvao7YY",
      "ended_at" : null,
      "merchant" : "MUrG5fHZJ8KXaf3GF6CWvhsY",
      "nickname" : "Security Fee",
      "started_at" : "2022-11-11T16:50:59.89Z",
      "subscription_schedule" : "SUBSCHEDULE_5BjWJUDiS5cdHSXEyYcvP1",
      "tags" : {
        "enrollment_info" : "Security Fee Enrollment"
      },
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_5SJ9GLz8rAn2aeFGnqtC6v"
        },
        "merchant" : {
          "href" : "https://finix.sandbox-payments-api.com/merchants/MUrG5fHZJ8KXaf3GF6CWvhsY"
        },
        "schedule" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_5BjWJUDiS5cdHSXEyYcvP1"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_5BjWJUDiS5cdHSXEyYcvP1/subscription_amounts"
        }
      }
    }, {
      "id" : "SUBENROLLMENT_dwzpQ2XxYcJ5NXmWw66zdc",
      "created_at" : "2022-01-05T02:08:38.44Z",
      "updated_at" : "2022-01-05T02:08:38.44Z",
      "created_by" : "USbkjk46XqUTQHN3i2jaVnc1",
      "ended_at" : null,
      "merchant" : "MUcpRFqZd66KX78cggJQ647x",
      "nickname" : "Security Fee",
      "started_at" : "2022-11-11T16:50:59.89Z",
      "subscription_schedule" : "SUBSCHEDULE_dgwg964fyjJRmmuoASzRmH",
      "tags" : {
        "enrollment_info" : "Security Fee Enrollment"
      },
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_dwzpQ2XxYcJ5NXmWw66zdc"
        },
        "merchant" : {
          "href" : "https://finix.sandbox-payments-api.com/merchants/MUcpRFqZd66KX78cggJQ647x"
        },
        "schedule" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_dgwg964fyjJRmmuoASzRmH"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_dgwg964fyjJRmmuoASzRmH/subscription_amounts"
        }
      }
    }, {
      "id" : "SUBENROLLMENT_aVjCRvKLXte9LaLKj4Chms",
      "created_at" : "2022-01-04T21:57:30.62Z",
      "updated_at" : "2022-01-04T21:57:30.62Z",
      "created_by" : "USbkjk46XqUTQHN3i2jaVnc1",
      "ended_at" : null,
      "merchant" : "MUm6Y99nmYz7DrTBnnMT3Hmi",
      "nickname" : "Security Fee",
      "started_at" : "2022-11-11T16:50:59.89Z",
      "subscription_schedule" : "SUBSCHEDULE_aC9bWkVMfoUfXS7hkxdD3d",
      "tags" : {
        "enrollment_info" : "Security Fee Enrollment"
      },
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_aVjCRvKLXte9LaLKj4Chms"
        },
        "merchant" : {
          "href" : "https://finix.sandbox-payments-api.com/merchants/MUm6Y99nmYz7DrTBnnMT3Hmi"
        },
        "schedule" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_aC9bWkVMfoUfXS7hkxdD3d"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_aC9bWkVMfoUfXS7hkxdD3d/subscription_amounts"
        }
      }
    }, {
      "id" : "SUBENROLLMENT_jaDVQHWdvBZ4EMnEQQhYVR",
      "created_at" : "2022-01-04T17:55:59.78Z",
      "updated_at" : "2022-01-04T17:55:59.78Z",
      "created_by" : "USbkjk46XqUTQHN3i2jaVnc1",
      "ended_at" : null,
      "merchant" : "MUsw6VcdKxAdm5VZz6eFFXfW",
      "nickname" : "Security Fee",
      "started_at" : "2022-11-11T16:50:59.89Z",
      "subscription_schedule" : "SUBSCHEDULE_iRNF53VNbZrb5hV9z69Ujf",
      "tags" : {
        "enrollment_info" : "Security Fee Enrollment"
      },
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_enrollments/SUBENROLLMENT_jaDVQHWdvBZ4EMnEQQhYVR"
        },
        "merchant" : {
          "href" : "https://finix.sandbox-payments-api.com/merchants/MUsw6VcdKxAdm5VZz6eFFXfW"
        },
        "schedule" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_iRNF53VNbZrb5hV9z69Ujf"
        },
        "amounts" : {
          "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_schedules/SUBSCHEDULE_iRNF53VNbZrb5hV9z69Ujf/subscription_amounts"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_enrollments?offset=0&limit=20&sort=created_at,desc&sort=id,desc"
    }
  },
  "page" : {
    "offset" : 0,
    "limit" : 20,
    "count" : 10
  }
}

HTTP Request

GET https://finix.sandbox-payments-api.com/subscription/subscription_enrollments

Response

Field Type Description
id string Subscription Enrollment ID
created_at string Timestamp of when the Subscription Enrollment was created
updated_at string Timestamp of when the Subscription Enrollment was last updated
created_by string User ID
ended_at string When the subscription will end in DateTime format
merchant string ID of the Merchant
nickname string Name of the Subscription Enrollment
started_at string When the subscription will begin in DateTime format
subscription_schedule string ID of the Subscription Schedule
tags object Key value pair for annotating custom metadata (e.g. order numbers)