Deprecated API Reference

This API Reference is being deprecated. Please use the New API Reference.

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" \
    -H 'Finix-Version:2022-02-01' \
    -u  UStxEci4vXxGDWLQhNvao7YY:25038781-2369-4113-8187-34780e91052e

Example Response:

Copy

Copied

{
  "_embedded" : {
    "subscription_enrollments" : [ {
      "id" : "SUBENROLLMENT_mgGfnXiVyFGvVjKk4Q16Ho",
      "created_at" : "2022-10-10T02:38:36.73Z",
      "updated_at" : "2022-10-10T02:38:36.73Z",
      "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_mgGfnXiVyFGvVjKk4Q16Ho"
        },
        "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_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"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_enrollments?offset=0&limit=20&sort=created_at,desc&sort=id,desc"
    },
    "next" : {
      "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_enrollments?offset=20&limit=20&sort=created_at,desc&sort=id,desc"
    },
    "last" : {
      "href" : "https://finix.sandbox-payments-api.com/subscription/subscription_enrollments?offset=20&limit=20&sort=created_at,desc&sort=id,desc"
    }
  },
  "page" : {
    "offset" : 0,
    "limit" : 20,
    "count" : 26
  }
}

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)